Skip to content

Commit da23b14

Browse files
committed
docs: update screenshot and docs
1 parent 854759a commit da23b14

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,24 @@
55
[![npm version][npm-version-src]][npm-version-href]
66
[![npm downloads][npm-downloads-src]][npm-downloads-href]
77

8-
A visual tool to help you view and understand your [ESLint Flat configs](https://eslint.org/docs/latest/use/configure/configuration-files-new).
8+
A visual tool for inspecting and understanding your [ESLint flat configs](https://eslint.org/docs/latest/use/configure/configuration-files-new).
99

10-
<img width="1199" alt="Screenshot" src="https://github.com/antfu/eslint-flat-config-viewer/assets/11247099/f386563a-c655-458e-a2c3-0af19ebec958">
11-
<img width="1199" alt="Screenshot" src="https://github.com/antfu/eslint-flat-config-viewer/assets/11247099/44edeb05-02b3-4bca-8da6-768984e8d829">
10+
<img width="1230" alt="Screenshot 1" src="https://github.com/eslint/config-inspector/assets/11247099/b3cbdd57-9374-4905-bfdc-cdd40646b747">
11+
<img width="1458" alt="Screenshot 2" src="https://github.com/eslint/config-inspector/assets/11247099/d008bf61-3685-4bf5-843f-524beb108305">
1212

1313
## Usage
1414

15-
Change the directory to your project root that contains `eslint.config.js` and run:
15+
Go to the project root that contains `eslint.config.js` and run:
1616

1717
```bash
1818
npx @eslint/config-inspector
1919
```
2020

21-
Goto http://localhost:7777/ to view your ESLint config. Whenever you update your ESLint config, the page will be updated automatically.
21+
Visit http://localhost:7777/ to view and play with your ESLint config. Changes to the config file will be updated automatically.
2222

23-
---
23+
### Online Preview
2424

25-
Or play it in your browser:
25+
Or play it right in your browser now:
2626

2727
[![](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/~/github.com/eslint/config-inspector)
2828

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"type": "module",
44
"version": "0.0.2",
55
"packageManager": "pnpm@8.15.5",
6-
"description": "A visual tool to help you view and understand your ESLint Flat config",
6+
"description": "A visual tool for inspecting and understanding your ESLint flat configs",
77
"license": "Apache-2.0",
88
"funding": "https://opencollective.com/eslint",
99
"homepage": "https://github.com/eslint/config-inspector#readme",

0 commit comments

Comments
 (0)