docs(readme): updated description, badges

and added acknowledgement
fixed #5

README.md

@@ -1,24 +1,28 @@
-# eslint-find-new-rules
+# eslint-rule-finder
 
 [![Join the chat at https://gitter.im/sarbbottam/eslint-rule-finder](https://badges.gitter.im/sarbbottam/eslint-rule-finder.svg)](https://gitter.im/sarbbottam/eslint-rule-finder?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 Use this for your own [ESLint](http://eslint.org/) [shareable configuration](http://eslint.org/docs/developer-guide/shareable-configs)
-to identify built-in ESLint rules that you're not explicitly configuring.
+to list current configured rules, all-available rules, unused rules, and plugin rules.
 
-[![Build Status](https://img.shields.io/travis/kentcdodds/eslint-find-new-rules.svg?style=flat-square)](https://travis-ci.org/kentcdodds/eslint-find-new-rules)
-[![Code Coverage](https://img.shields.io/codecov/c/github/kentcdodds/eslint-find-new-rules.svg?style=flat-square)](https://codecov.io/github/kentcdodds/eslint-find-new-rules)
-[![version](https://img.shields.io/npm/v/eslint-find-new-rules.svg?style=flat-square)](http://npm.im/eslint-find-new-rules)
-[![downloads](https://img.shields.io/npm/dm/eslint-find-new-rules.svg?style=flat-square)](http://npm-stat.com/charts.html?package=eslint-find-new-rules&from=2015-08-01)
-[![MIT License](https://img.shields.io/npm/l/eslint-find-new-rules.svg?style=flat-square)](http://opensource.org/licenses/MIT)
+[![Build Status](https://img.shields.io/travis/sarbbottam/eslint-rule-finder.svg?style=flat-square)](https://travis-ci.org/sarbbottam/eslint-rule-finder)
+[![Code Coverage](https://img.shields.io/codecov/c/github/sarbbottam/eslint-rule-finder.svg?style=flat-square)](https://codecov.io/github/sarbbottam/eslint-rule-finder)
+[![version](https://img.shields.io/npm/v/eslint-rule-finder.svg?style=flat-square)](http://npm.im/eslint-rule-finder)
+[![downloads](https://img.shields.io/npm/dm/eslint-rule-finder.svg?style=flat-square)](http://npm-stat.com/charts.html?package=eslint-rule-finder&from=2015-08-01)
+[![MIT License](https://img.shields.io/npm/l/eslint-rule-finder.svg?style=flat-square)](http://opensource.org/licenses/MIT)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
 [![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors)
 
+## Acknowledgement
+
+This module is an extended version of [eslint-find-new-rules](https://github.com/kentcdodds/eslint-find-new-rules)
+
 ## Installation
 
 Simply install locally as a development dependency to your project's package:
 
 ```
-npm install --save-dev eslint-find-new-rules
+npm install --save-dev eslint-rule-finder
 ```
 
 ## Usage
@@ -29,23 +33,27 @@ The intended usage is as an npm script:
 {
   ...
   "scripts": {
-    "find-new-rules": "eslint-find-new-rules path/to/eslint-config"
+    "eslint-find-option-rules": "eslint-rule-finder [option] <file>"
   }
   ...
 }
 ```
 
-Then run it with: `$ npm run find-new-rules -s` (the `-s` is to silence npm output).
+```
+available options are -c|--current, -a|--all-available, -p|--plugin, -u|--unused
+```
+Then run it with: `$ npm run eslint-find-option-rules -s` (the `-s` is to silence npm output).
 
 ### Specify a file
 
-This is really handy in an actual config module (like [mine](https://github.com/kentcdodds/eslint-config-kentcdodds)) where you could also do:
+This is really handy in an actual config module (like [eslint-config-kentcdodds](https://github.com/kentcdodds/eslint-config-kentcdodds)) where you could also do:
 
 ```
-eslint-find-new-rules ./index.js
+// available options are -c|--current, -a|--all-available, -p|--plugin, -u|--unused
+eslint-rule-finder --option ./index.js
 ```
 
-This is resolved relative to the `process.cwd()` which, in the context of npm scripts is always the location of your `package.json`.
+This is resolved, relative to the `process.cwd()` which, in the context of `npm` scripts is always the location of your `package.json`.
 
 You may specify any [config format supported by ESLint](http://eslint.org/docs/user-guide/configuring).
 
@@ -54,23 +62,23 @@ You may specify any [config format supported by ESLint](http://eslint.org/docs/u
 You can also provide an absolute path:
 
 ```
-eslint-find-new-rules ~/Developer/eslint-config-kentcdodds/index.js
+eslint-rule-finder --option ~/Developer/eslint-config-kentcdodds/index.js
 ```
 
 **Please note** that any tested ESLint config file must reside below your project's root.
 
 ### Default to `main`
 
-It will also default to the `main` in your `package.json`, so you can omit the argument altogether:
+It will also default to the `main` in your `package.json`, so you can omit the `path/to/file` argument:
 
 ```
-eslint-find-new-rules
+eslint-rule-finder --option
 ```
 
 ### As a `require`d module
 
 ```
-var getRuleFinder = require('./eslint-find-new-rules')
+var getRuleFinder = require('./eslint-rule-finder')
 var ruleFinder = getRuleFinder('path/to/eslint-config')
 
 // default to the `main` in your `package.json`