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
stingalleman committed Nov 11, 2020
1 parent 0112c31 commit 61aae09
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,31 @@

The ESLint config Tribecamp uses.

## Usage
## Installation

Install this package (`yarn add --dev @tribecamp/eslint`) and extend it in your `.eslintrc.*`.
There are four packages available. Each of them can be installed with `yarn install @tribecamp/...`.

There are four configs you can choose from. These are the options:
```txt
@tribecamp/eslint-config-base
@tribecamp/eslint-config-jest
@tribecamp/eslint-config-typescript
@tribecamp/eslint-config-vue
```

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

```js
module.exports = {
extends: [
'./node_modules/@tribecamp/eslint/base',
'./node_modules/@tribecamp/eslint/typescript',
'./node_modules/@tribecamp/eslint/vue',
'./node_modules/@tribecamp/eslint/jest'
'@tribecamp/eslint-config-base',
'@tribecamp/eslint-config-jest',
'@tribecamp/eslint-config-typescript',
'@tribecamp/eslint-config-vue'
]
};
```
> We will eventually split up our config into separate npm packages, but for now, you should extend your
> config using relative paths to the modules.

You'll most likely get a lot of warnings about missing packages. Just install them, and you should be good to go.
You can just remove the configs you don't need.

## License

Expand Down

0 comments on commit 61aae09

Please sign in to comment.