Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,25 @@ Generate docs and start the doc-server:
```
$ make
```

## FAQ

#### How can I get my plugin featured on the website?

This happens automatically! Every day we have an automated build process which looks for npm modules with the `chai-plugin` keyword. If you publish a chai plugin to npm then make sure it has the `keywords` array in the `package.json` that includes the string `"chai-plugin"`. Like so:

```json
{
"name": "my-awesome-chai-plugin",
"keywords": [ "chai-plugin" ]
}
```

If your plugin supports web browsers, as well as node.js, then you can add the `"browser"` keyword. If your plugin _only_ supports browsers, then add both `"browser"` and `"browser-only"` keywords:

```json
{
"name": "chai-dom",
"keywords": [ "chai-plugin", "browser", "browser-only" ]
}
```