add how does it work section to readme

This commit is contained in:
Sebastian McKenzie 2015-02-28 12:03:01 +11:00
parent 5b2df4ce30
commit 24aa904d99

View File

@ -34,3 +34,10 @@ Check out the [ESLint docs](http://eslint.org/docs/rules/) for all possible rule
```sh ```sh
$ eslint your-files-here $ eslint your-files-here
``` ```
## How does it work?
ESLint allows custom parsers. This is great but some of the syntax nodes that Babel supports
aren't supported by ESLint. When using this plugin, ESLint is monkeypatched and your code is
transformed into code that ESLint can understand. All location info such as line numbers,
columns is also retained so you can track down errors with ease.