Skip to content
This repository has been archived by the owner on Jan 25, 2022. It is now read-only.

Commit

Permalink
docs(readme): update README
Browse files Browse the repository at this point in the history
  • Loading branch information
keesvv committed Nov 11, 2020
1 parent 61aae09 commit 3f30b9d
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ The ESLint config Tribecamp uses.

## Installation

There are four packages available. Each of them can be installed with `yarn install @tribecamp/...`.
There are four packages available. Each of them can be installed with `yarn add --dev @tribecamp/eslint-config-<name>`.
The following packages can be installed:

```txt
@tribecamp/eslint-config-base
Expand All @@ -13,20 +14,20 @@ There are four packages available. Each of them can be installed with `yarn inst
@tribecamp/eslint-config-vue
```

You then need to extend the installed package in your `.eslintrc.js`, like this:
You may then extend the installed package(s) in your `.eslintrc.js`, like this:

```js
module.exports = {
extends: [
'@tribecamp/eslint-config-base',
'@tribecamp/eslint-config-jest',
'@tribecamp/eslint-config-typescript',
'@tribecamp/eslint-config-vue'
'@tribecamp/base',
'@tribecamp/jest',
'@tribecamp/typescript',
'@tribecamp/vue'
]
};
```

You can just remove the configs you don't need.
Feel free to remove any configs you don't need.

## License

Expand Down

0 comments on commit 3f30b9d

Please sign in to comment.