Skip to content

Commit

Permalink
fix: convert README template usage to flat
Browse files Browse the repository at this point in the history
  • Loading branch information
MikeMcC399 committed Oct 19, 2024
1 parent e0bbfd4 commit 20d3664
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions plugin/templates/_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,23 +18,23 @@ npm install eslint-plugin-<%= pluginId %> --save-dev

## Usage

Add `<%= pluginId %>` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
Add `<%= pluginId %>` to the `plugins` key of your [configuration file](https://eslint.org/docs/latest/use/configure/configuration-files#configuration-file). You can omit the `eslint-plugin-` prefix:

```json
```js
{
"plugins": [
plugins: {
"<%= pluginId %>"
]
}
}
```

<% if (hasRules) { %>
Then configure the rules you want to use under the rules section.
Then configure the rules you want to use under the `rules` key.

```json
```js
{
"rules": {
"<%= pluginId %>/rule-name": 2
rules: {
"<%= pluginId %>/rule-name": "warn"
}
}
```
Expand Down

0 comments on commit 20d3664

Please sign in to comment.