Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
eduardoteles17 committed Aug 10, 2022
1 parent 3f22aa8 commit 4050aea
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# Cod3Rocket eslint config

Eslint config use by Cod3Rocket
Eslint config use by Cod3Rocket. It is based on the eslint config [eslint-config-airbnb](https://www.npmjs.com/package/eslint-config-airbnb) with little changes.

## Usage

### Install peer dependencies

```bash
pnpm add -D @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-airbnb eslint-config-prettier eslint-plugin-import eslint-plugin-import-helpers eslint-plugin-prettier prettier typescript
```
Expand All @@ -14,6 +16,22 @@ with use with react.
pnpm add -D eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks
```

and install `eslint-config-cod3rocket`

```bash
pnpm add -D eslint-config-cod3rocket
```

## Configuration

in our eslint config file

```json
{
"extends": ["cod3rocket"],
}
```

## License

[MIT](./LICENSE)

0 comments on commit 4050aea

Please sign in to comment.