Skip to content

Commit f25b350

Browse files
committed
docs: update README.md and website
1 parent bfc3be2 commit f25b350

File tree

5 files changed

+18
-10
lines changed

5 files changed

+18
-10
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22

33
<h1 align="center" alt="title">ESLint React</h1>
44

5-
A full TypeScript rewrite of eslint-plugin-react, with well-designed rule behaviors and sensible defaults for modern React apps.
5+
More than 50 ESLint rules to catch common mistakes and improve your React code. Rewritten from the scratch (mostly).
66

77
## Highlights
88

9-
- Full TypeScript rewrite.
109
- Well designed rule behaviors and sensible defaults.
1110
- Maximum flexibility through minimum configuration options.
1211
- No auto-fix, Formatting independent, treat your codebase like it's read-only.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@eslint-react/monorepo",
33
"version": "0.10.6-beta.0",
4-
"description": "ESLint React's monorepo. A full TypeScript rewrite of eslint-plugin-react, with well-designed rule behaviors and sensible defaults for modern React apps.",
4+
"description": "ESLint React's monorepo. More than 50 ESLint rules to catch common mistakes and improve your React code. Rewritten from the scratch (mostly).",
55
"keywords": [
66
"eslint",
77
"eslint-plugin",

packages/plugins/eslint-plugin/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<h1 align="center" alt="title">ESLint React</h1>
44

5-
A full TypeScript rewrite of eslint-plugin-react, with well-designed rule behaviors and sensible defaults for modern React apps.
5+
More than 50 ESLint rules to catch common mistakes and improve your React code. Rewritten from the scratch (mostly).
66

77
## Supported React versions
88

packages/plugins/eslint-plugin/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@eslint-react/eslint-plugin",
33
"version": "0.10.6-beta.0",
4-
"description": "ESLint React's main ESLint plugin. A full TypeScript rewrite of eslint-plugin-react, with well-designed rule behaviors and sensible defaults for modern React apps.",
4+
"description": "ESLint React's main ESLint plugin. More than 50 ESLint rules to catch common mistakes and improve your React code. Rewritten from the scratch (mostly).",
55
"keywords": [
66
"eslint",
77
"eslint-plugin",

website/pages/index.mdx

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
import { Warning } from "#/components/callout";
21
import { ESLintReactCard } from "#/components/eslint-react-card/eslint-react-card";
32

43
<ESLintReactCard />
@@ -7,7 +6,17 @@ Welcome to the ESLint React documentation.
76

87
More than 50 ESLint rules to catch common mistakes and improve your React code. Rewritten from the scratch (mostly).
98

10-
<Warning>
11-
Please note that the documentation is currently under construction and some
12-
sections may be incomplete or subject to changes.
13-
</Warning>
9+
## Installation
10+
11+
```sh
12+
# npm
13+
npm install --save-dev @eslint-react/eslint-plugin
14+
```
15+
16+
[Full Installation Guide ↗](/docs/installation)
17+
18+
## Highlights
19+
20+
- Well designed rule behaviors and sensible defaults.
21+
- Maximum flexibility through minimum configuration options.
22+
- No auto-fix, Formatting independent, treat your codebase like it's read-only.

0 commit comments

Comments
 (0)