eslint-config-sugarshin/README.md

My ESLint shareable config

# eslint-config-sugarshin

[![Build Status][travis-image]][travis-url]
[![GitHub version][github-ver-image]][github-ver-url]
[![License][license-image]][license-url]

My ESLint shareable config

## Getting started

```
npm i -D eslint-config-sugarshin
```

## Usage

### Standard (ES6)

```
npm i -D eslint-config-sugarshin babel-eslint eslint-plugin-babel eslint
```

add `extends: 'sugarshin'` to `.eslintrc`

### ES6 + React

```
npm i -D eslint-config-sugarshin babel-eslint eslint-plugin-babel eslint-plugin-react eslint
```

add `extends: 'sugarshin/react'` to `.eslintrc`

### Legacy

less than ES6

```
npm i -D eslint-config-sugarshin eslint
```

add `extends: 'sugarshin/base'` to `.eslintrc`

## Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

## License

[MIT][license-url]

© sugarshin

[npm-image]: http://img.shields.io/npm/v/eslint-config-sugarshin.svg
[npm-url]: https://www.npmjs.org/package/eslint-config-sugarshin
[bower-image]: http://img.shields.io/bower/v/eslint-config-sugarshin.svg
[bower-url]: http://bower.io/search/?q=eslint-config-sugarshin
[travis-image]: http://img.shields.io/travis/sugarshin/eslint-config-sugarshin/master.svg?branch=master
[travis-url]: https://travis-ci.org/sugarshin/eslint-config-sugarshin
[gratipay-image]: http://img.shields.io/gratipay/sugarshin.svg
[gratipay-url]: https://gratipay.com/sugarshin/
[coveralls-image]: https://coveralls.io/repos/sugarshin/eslint-config-sugarshin/badge.svg
[coveralls-url]: https://coveralls.io/r/sugarshin/eslint-config-sugarshin
[github-ver-image]: https://badge.fury.io/gh/sugarshin%2Feslint-config-sugarshin.svg
[github-ver-url]: http://badge.fury.io/gh/sugarshin%2Feslint-config-sugarshin
[license-image]: http://img.shields.io/:license-mit-blue.svg
[license-url]: http://sugarshin.mit-license.org/
[downloads-image]: http://img.shields.io/npm/dm/eslint-config-sugarshin.svg
[dependencies-image]: http://img.shields.io/david/sugarshin/eslint-config-sugarshin.svg