update gemspec (cosmetical changes)

[github/fretlink/pronto-hlint.git] / README.md

diff --git a/README.md b/README.md
index 1660df7461ade7426e7c3c2816a3923eef0616e9..5e53859dfe479dbf60c4745e8a4fdbc5f0cab05c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,25 +1,45 @@
 # Pronto runner for ESLint (using eslint from npm)
 
-[![Code Climate](https://codeclimate.com/github/doits/pronto-eslint-npm.svg)](https://codeclimate.com/github/doits/pronto-eslint-npm)
-[![Build Status](https://travis-ci.org/doits/pronto-eslint-npm.svg?branch=master)](https://travis-ci.org/doits/pronto-eslint-npm)
-[![Gem Version](https://badge.fury.io/rb/pronto-eslint-npm.svg)](http://badge.fury.io/rb/pronto-eslint-npm)
-[![Dependency Status](https://gemnasium.com/doits/pronto-eslint-npm.svg)](https://gemnasium.com/doits/pronto-eslint-npm)
+[![Code Climate](https://codeclimate.com/github/doits/pronto-eslint_npm.svg)](https://codeclimate.com/github/doits/pronto-eslint_npm)
+[![Build Status](https://travis-ci.org/doits/pronto-eslint_npm.svg?branch=master)](https://travis-ci.org/doits/pronto-eslint_npm)
+[![Gem Version](https://badge.fury.io/rb/pronto-eslint_npm.svg)](http://badge.fury.io/rb/pronto-eslint_npm)
+[![Dependency Status](https://gemnasium.com/doits/pronto-eslint_npm.svg)](https://gemnasium.com/doits/pronto-eslint_npm)
 
 Pronto runner for [ESlint](http://eslint.org), pluggable linting utility for JavaScript and JSX. [What is Pronto?](https://github.com/mmozuras/pronto)
 
-Uses system wide installed eslint in contrast to [pronto-eslint][pronto-eslint].
+Uses official eslint executable installed by `npm` in contrast to [pronto-eslint][pronto-eslint].
 
 [pronto-eslint]: https://github.com/mmozuras/pronto-eslint
 
 ## Prerequisites
 
-You'll need to install [eslint by yourself with npm][eslint-install].
+You'll need to install [eslint by yourself with npm][eslint-install]. If `eslint` is in your `PATH`, everything will simply work, otherwise you have to provide pronto-eslint-npm your custom executable path (see [below](#configuration-of-eslintnpm)).
 
 [eslint-install]: http://eslint.org/docs/user-guide/getting-started
 
-## Configuration
+## Configuration of ESLint
 
-Configuring ESLint via [.eslintrc and consorts][eslintrc] and excludes via [.eslintignore][eslintignore] will work just fine with pronto-eslint.
+Configuring ESLint via [.eslintrc and consorts][eslintrc] and excludes via [.eslintignore][eslintignore] will work just fine with pronto-eslint-npm.
 
 [eslintrc]: http://eslint.org/docs/user-guide/configuring#configuration-file-formats
+
 [eslintignore]: http://eslint.org/docs/user-guide/configuring#ignoring-files-and-directories
+
+## Configuration of ESLintNPM
+
+pronto-eslint-npm can be configured by placing a `.pronto_eslint_npm.yml` inside the directory where pronto is run.
+
+Following options are available:
+
+| Option            | Meaning                                                                                  | Default                             |
+| ----------------- | ---------------------------------------------------------------------------------------- | ----------------------------------- |
+| eslint_executable | ESLint executable to call.                                                               | `eslint` (calls `eslint` in `PATH`) |
+| files_to_lint     | What files to lint. Absolute path of offending file will be matched against this Regexp. | `(\.js|\.es6)$`                     |
+
+Example configuration to call custom eslint executable and only lint files ending with `.my_custom_extension`:
+
+```yaml
+# .pronto_eslint_npm.yaml
+eslint_executable: '/my/custom/node/path/.bin/eslint'
+files_to_lint: '\.my_custom_extension$'
+```