]> git.immae.eu Git - github/fretlink/pronto-hlint.git/blame - README.md
Add instructions into README about installing eslint
[github/fretlink/pronto-hlint.git] / README.md
CommitLineData
ce89f9ed
MM
1# Pronto runner for ESLint
2
3[![Code Climate](https://codeclimate.com/github/mmozuras/pronto-eslint.png)](https://codeclimate.com/github/mmozuras/pronto-eslint)
4[![Build Status](https://travis-ci.org/mmozuras/pronto-eslint.png)](https://travis-ci.org/mmozuras/pronto-eslint)
5[![Gem Version](https://badge.fury.io/rb/pronto-eslint.png)](http://badge.fury.io/rb/pronto-eslint)
6[![Dependency Status](https://gemnasium.com/mmozuras/pronto-eslint.png)](https://gemnasium.com/mmozuras/pronto-eslint)
7
8Pronto runner for [ESlint](http://eslint.org), pluggable linting utility for JavaScript and JSX. [What is Pronto?](https://github.com/mmozuras/pronto)
9
10## Prerequisites
11
c2307793
MD
12You'll need to install [eslint by yourself][eslint-install].
13
14[eslint-install]: http://eslint.org/docs/user-guide/getting-started
ce89f9ed
MM
15
16## Configuration
17
c2307793 18Configuring ESLint via [.eslintrc and consorts][eslintrc] and excludes via [.eslintignore][eslintignore] will work just fine with pronto-eslint.
676cea90 19
c2307793 20[eslintrc]: http://eslint.org/docs/user-guide/configuring#configuration-file-formats
676cea90 21[eslintignore]: http://eslint.org/docs/user-guide/configuring#ignoring-files-and-directories