Skip to content
This repository was archived by the owner on Nov 8, 2024. It is now read-only.

Commit a6f5f90

Browse files
msanromanphilippemiguet
authored andcommitted
Add README.md
1 parent a5358a4 commit a6f5f90

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

eslint/README.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# @bufferapp/eslint-config
2+
3+
This is the standard ESLint config files for the projects within the @bufferapp
4+
GitHub organization.
5+
6+
## Usage
7+
8+
```console
9+
npm install --save-dev @bufferapp/eslint-config eslint
10+
# or
11+
yarn add -D @bufferapp/eslint-config eslint
12+
```
13+
14+
NOTE: We will need to define custom installation instructions for front-end
15+
and backend-based configs, depending on those we will have different
16+
`peerDependencies` for the ESLint configs.
17+
18+
And then, on your `.eslintrc` use
19+
20+
```
21+
"extends": "@bufferapp/eslint-config-backend"
22+
#or
23+
"extends": "@bufferapp/eslint-config-frontend"
24+
```

0 commit comments

Comments
 (0)