Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
au2001 committed Jan 25, 2024
1 parent 7004097 commit 16dbc1a
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This library contains the [ESLint](https://eslint.org) configuration used by [Avicenne Studio](https://avicenne.studio).

Consider using the [TypeScript configuration bundle](https://npm.im/@avicenne-studio/typescript-config) instead of this library directly.

## Installing the library

```bash
Expand All @@ -10,12 +12,12 @@ npm install --save-dev @avicenne-studio/eslint-config

## Using the library

To use the library, you'll need to add the following to your `.eslintrc.js` file:
To use the library, you'll need to add the following to your `.eslintrc.json` file:

```js
module.exports = {
extends: "@avicenne-studio",
};
```json
{
"extends": "@avicenne-studio",
}
```

## Publishing updates
Expand Down

0 comments on commit 16dbc1a

Please sign in to comment.