Skip to content

Commit

Permalink
Fix #2 Create README
Browse files Browse the repository at this point in the history
  • Loading branch information
robsonbittencourt committed Oct 22, 2016
1 parent 343dc49 commit ac63b26
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,31 @@
# eslint-config-hubot-js
Eslint for Hubot.js projects

[![npm](https://img.shields.io/npm/v/eslint-config-hubot-js.svg)](https://www.npmjs.com/package/eslint-config-hubot-js)
[![dependencies-badge](https://david-dm.org/hubot-js/eslint-config-hubot-js.svg)](https://david-dm.org/hubot-js/eslint-config-hubot-js) [![devDependencies Status](https://david-dm.org/hubot-js/eslint-config-hubot-js/dev-status.svg)](https://david-dm.org/hubot-js/eslint-config-hubot-js?type=dev)

> Eslint for Hubot.js projects
## Usage

This is a [Eslint](http://eslint.org/) setting made for [hubot.js](https://github.com/hubot-js/hubot.js) and its [auxiliary projects](https://github.com/hubot-js). It extends the great [airbnb configuration](https://www.npmjs.com/package/eslint-config-airbnb) modifying some rules.

To use this setting your project you must have eslint as a [dependency in your project or instaled globally](http://eslint.org/docs/user-guide/getting-started). In addition a .eslintrc.json file must be created to extend this setting. See the example:

```
{
"extends": "hubot-js"
}
```

After that you can run the eslint with the command:

```
eslint .
```

Or integrate it with your [text editor](http://eslint.org/docs/user-guide/integrations):

![eslint-text-editor-example](https://s22.postimg.org/8pnm0q49d/eslint_text_editor_example.jpg)


If you have questions use the [hubot.js project](https://github.com/hubot-js/hubot.js) as an example, or open an [issue](https://github.com/robsonbittencourt/eslint-config-hubot-js/issues).

0 comments on commit ac63b26

Please sign in to comment.