Skip to content

Commit

Permalink
docs(usage): updated documentation to reflect the breaking changes
Browse files Browse the repository at this point in the history
  • Loading branch information
sarbbottam committed Mar 28, 2016
1 parent 6a3abb2 commit bafb885
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The intended usage is as an npm script:
{
...
"scripts": {
"find-new-rules": "eslint-find-new-rules eslint-config-yourConfigName"
"find-new-rules": "eslint-find-new-rules path/to/eslint-config"
}
...
}
Expand Down Expand Up @@ -65,6 +65,27 @@ It will also default to the `main` in your `package.json`, so you can omit the a
eslint-find-new-rules
```

### As a `require`d module

```
var getRuleFinder = require('./eslint-find-new-rules')
var ruleFinder = getRuleFinder('path/to/eslint-config')
// default to the `main` in your `package.json`
// var ruleFinder = getRuleFinder()
// get all the current, plugin, available and unused rules
// without referring the extended files or documentation
ruleFinder.getCurrentRules()
ruleFinder.getPluginRules()
ruleFinder.getAllAvailableRules()
ruleFinder.getUnusedRules()
```

## Contributors

Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
Expand Down

0 comments on commit bafb885

Please sign in to comment.