Skip to content
This repository was archived by the owner on Oct 22, 2023. It is now read-only.

Commit 73beea6

Browse files
committed
Add readme file with installation & usage info.
1 parent 8337da6 commit 73beea6

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Release Notes Coding Style
2+
3+
Extends [Airbnb JavaScript Style Guide][airbnb-js-styleguide] for use on [release-notes][release-notes] node projects.
4+
5+
## Installation
6+
7+
`$ npm i --save-dev @release-notes/eslint-config eslint eslint-plugin-import`
8+
9+
And add an `.eslintrc.yml` file:
10+
11+
```yml
12+
extends: '@release-notes'
13+
14+
plugins:
15+
- import
16+
17+
env:
18+
es6: true
19+
node: true
20+
21+
parserOptions:
22+
sourceType: script
23+
```
24+
25+
## Usage
26+
27+
Run `npm run lint` in order to test the codebase for coding standard violations.
28+
29+
---
30+
31+
### LICENSE
32+
33+
The files in this archive are released under MIT license.
34+
You can find a copy of this license in [LICENSE](LICENSE).
35+
36+
37+
[airbnb-js-styleguide]: https://github.com/airbnb/javascript
38+
[release-notes]: https://github.com/release-notes/release-notes

0 commit comments

Comments
 (0)