Skip to content

Commit

Permalink
Merge pull request #74 from bmish/update-readme-2
Browse files Browse the repository at this point in the history
  • Loading branch information
bmish authored Oct 8, 2022
2 parents 3deb183 + 60c9c8c commit 88ca40c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Automatic documentation generator for [ESLint](https://eslint.org/) plugins and

Generates the following documentation based on ESLint and top [ESLint plugin](https://eslint.org/docs/latest/developer-guide/working-with-plugins) conventions:

- README rules table
- `README.md` rules table
- Rule doc titles and notices

Also performs some basic section consistency checks on rule docs:
Expand All @@ -21,7 +21,7 @@ Install it:
npm i --save-dev eslint-doc-generator
```

Add it as as script in `package.json` (included as a lint script to demonstrate how we can ensure it passes and is up-to-date on CI):
Add it as as script in `package.json` (included as a lint script to demonstrate how we can ensure it passes and is up-to-date in CI):

```json
{
Expand All @@ -42,7 +42,7 @@ Delete any old rules list from your `README.md`. A new one will be automatically
<!-- end rules list -->
```

Delete any old recommended/fixable/etc notices from your rule docs. A new title and notices will be automatically added to the top of each rule doc (along with a marker comment if it doesn't exist yet).
Delete any old recommended/fixable/etc. notices from your rule docs. A new title and notices will be automatically added to the top of each rule doc (along with a marker comment if it doesn't exist yet).

## Usage

Expand Down

0 comments on commit 88ca40c

Please sign in to comment.