Skip to content

Commit

Permalink
docs: add CLI options to readme (#88)
Browse files Browse the repository at this point in the history
  • Loading branch information
mmkal committed Sep 17, 2024
1 parent c5bd76d commit 3fdd717
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ npx @eslint/config-inspector@latest

Visit http://localhost:7777/ to view and play with your ESLint config. Changes to the config file will be updated automatically.

Run `npx @eslint/config-inspector --help` to see all the CLI options available.

### Online Preview

Or play it right in your browser now:
Expand All @@ -36,6 +38,8 @@ npx @eslint/config-inspector build

This will generate a Single-Page Application (SPA) under `.eslint-config-inspector`, with the snapshot of the current ESLint config. You can deploy it somewhere, or use it for comparison etc.

Run `npx @eslint/config-inspector build --help` to see all the CLI options available.

## Contributing

We operate under the [ESLint Contributor Guidelines](http://eslint.org/docs/developer-guide/contributing), so please be sure to read them before contributing. If you're not sure where to dig in, check out the [issues](https://github.com/eslint/config-inspector/issues).
Expand Down

0 comments on commit 3fdd717

Please sign in to comment.