Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add CLI options to readme #88

Merged
merged 3 commits into from
Sep 17, 2024
Merged

docs: add CLI options to readme #88

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ed0d031
Add CLI options to readme
mmkal Sep 2, 2024
c9694b8
🙈
mmkal Sep 2, 2024
fc26916
Suggest running `--help` to see options
mmkal Sep 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
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