Skip to content

Commit 9f4be50

Browse files
committed
Update readme
1 parent 450bb63 commit 9f4be50

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,21 @@
66
[![Paypal Donate](https://img.shields.io/badge/Donate-paypal-blue.svg?style=flat-square&logo=paypal&colorA=cccccc)](https://acel.me/donate)
77

88
Coding standard used by Shlink JavaScript projects.
9+
10+
This library includes two ESLint configurations, the base one, and the react-specific one. Default export includes both:
11+
12+
```js
13+
// eslint.config.js
14+
import shlink from '@shlinkio/eslint-config-js-coding-standard';
15+
16+
export default shlink;
17+
```
18+
19+
If the project does not use React, you can just use the base config:
20+
21+
```js
22+
// eslint.config.js
23+
import { baseConfig } from '@shlinkio/eslint-config-js-coding-standard';
24+
25+
export default baseConfig;
26+
```

0 commit comments

Comments
 (0)