Skip to content
This repository was archived by the owner on Sep 20, 2021. It is now read-only.

Commit 037482a

Browse files
committed
docs: add license and readme
1 parent 0784e26 commit 037482a

File tree

2 files changed

+52
-0
lines changed

2 files changed

+52
-0
lines changed

LICENSE

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright 2018 Smooth Code
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# eslint-config-smooth
2+
3+
[![travis][travis-image]][travis-url]
4+
[![npm][npm-image]][npm-url]
5+
6+
[travis-image]: https://img.shields.io/travis/smooth-code/eslint-config-smooth/master.svg
7+
[travis-url]: https://travis-ci.org/smooth-code/eslint-config-smooth
8+
[npm-image]: https://img.shields.io/npm/v/eslint-config-smooth.svg
9+
[npm-url]: https://npmjs.org/package/eslint-config-smooth
10+
11+
## Install
12+
13+
```bash
14+
npm install eslint-config-smooth
15+
```
16+
17+
## Usage
18+
19+
Shareable configs are designed to work with the `extends` feature of `.eslintrc` files.
20+
You can learn more about
21+
[Shareable Configs](http://eslint.org/docs/developer-guide/shareable-configs) on the
22+
official ESLint website.
23+
24+
To use the JavaScript Standard Style shareable config, first run this:
25+
26+
```bash
27+
npm install --save-dev eslint-config-smooth eslint-config-airbnb eslint-config-prettier eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react babel-eslint eslint
28+
```
29+
30+
Then, add this to your .eslintrc file:
31+
32+
```
33+
{
34+
"extends": "smooth"
35+
}
36+
```
37+
38+
_Note: We omitted the `eslint-config-` prefix since it is automatically assumed by ESLint._
39+
40+
You can override settings from the shareable config by adding them directly into your
41+
`.eslintrc` file.
42+
43+
## License
44+
45+
MIT

0 commit comments

Comments
 (0)