Skip to content

Commit bb1df92

Browse files
committed
Update docs to include instructions
1 parent bcb0c4f commit bb1df92

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,27 @@ Utilizes the following plugins:
1616

1717

1818
![alt text](demo/example-eslint-results.png "Example linting infractions for things the Tree team cares about")
19+
20+
## Usage:
21+
22+
1. Add either `eslint-config-tree` or `eslint-config-frontier-react` as a devDependency.
23+
24+
1. Add this repository as a package devDependency:
25+
26+
> "eslint-config-tree": "github:fs-webdev/eslint-config-tree#semver:^1",
27+
28+
1. In your `eslintrc.js` file, put the following:
29+
<pre><code>module.exports = {
30+
extends: [
31+
'frontier',
32+
'tree'
33+
],
34+
plugins: [
35+
'eslint-plugin-deprecate',
36+
'eslint-plugin-sonarjs'
37+
]
38+
}</code></pre>
39+
40+
1. Add both `tree` and the frontier eslint configuration of your choice as Code Climate `prepare` resources (see: [extended eslint docs](https://www.familysearch.org/frontier/legacy/ui-components/eslint-config-frontier/)).
41+
42+
1. Enjoy.

0 commit comments

Comments
 (0)