Skip to content

Commit

Permalink
docs: improve readme and settings docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Rel1cx committed Dec 23, 2024
1 parent 5d8e569 commit c47e8d5
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 11 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ A series of composable ESLint plugins for libraries and frameworks that use Reac

## Features

- **Universal** rules for libraries and frameworks that use React as a UI runtime.
- **Well designed** rule behaviors and sensible defaults.
- **Maximum flexibility** through minimum rule options.
- **Universal**: Works seamlessly with any library or framework that uses React.
- **Maximum Flexibility**: Achieves extensive capabilities with minimal configuration effort.
- **Advanced Analysis Logic**: Handles complex scenarios and identifies errors that tools like `biome` and `eslint-plugin-react` can't.

## Public packages

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@eslint-react/monorepo",
"version": "1.22.1-beta.1",
"private": true,
"description": "Monorepo for eslint-plugin-react-[x, dom, web-api, hooks-extra, naming-convention].",
"description": "Monorepo for eslint-plugin-react-[x, dom, web-api, hooks-extra, naming-convention]. The most advanced lint rules for React.",
"keywords": [
"react",
"eslint",
Expand Down
6 changes: 3 additions & 3 deletions packages/plugins/eslint-plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ A series of composable ESLint plugins for libraries and frameworks that use Reac

## Features

- **Universal** rules for libraries and frameworks that use React as a UI runtime.
- **Well designed** rule behaviors and sensible defaults.
- **Maximum flexibility** through minimum rule options.
- **Universal**: Works seamlessly with any library or framework that uses React.
- **Maximum Flexibility**: Achieves extensive capabilities with minimal configuration effort.
- **Advanced Analysis Logic**: Handles complex scenarios and identifies errors that tools like `biome` and `eslint-plugin-react` can't.

## Public packages

Expand Down
2 changes: 1 addition & 1 deletion packages/plugins/eslint-plugin/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@eslint-react/eslint-plugin",
"version": "1.22.1-beta.1",
"description": "The main ESLint plugin of ESLint React. Contains all the rules and presets of ESLint React.",
"description": "The main ESLint plugin that contains all the rules from eslint-plugin-react-[x, dom, web-api, hooks-extra, naming-convention].",
"keywords": [
"react",
"eslint",
Expand Down
2 changes: 2 additions & 0 deletions website/pages/docs/configurations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ A object of aliases for React built-in hooks. ESLint React will recognize these

An array of user-defined components, used to inform the ESLint React plugins how to treat these components during checks.

This can be incredibly helpful for rules to understand the semantics of user-defined components and their props (e.g. `<Link to="/home" />`, `<Box as="form" />`, `<Button component="a" />`).

## Examples

<ESLintConfigTabs>
Expand Down
6 changes: 3 additions & 3 deletions website/pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ A series of composable ESLint plugins for libraries and frameworks that use Reac

## Features

- **Universal** rules for libraries and frameworks that use React as a UI runtime.
- **Well designed** rule behaviors and sensible defaults.
- **Maximum flexibility** through minimum rule options.
- **Universal**: Work seamlessly with any library or framework that uses React.
- **Maximum Flexibility**: Achieves extensive capabilities with minimal configuration effort.
- **Advanced Analysis Logic**: Handles complex scenarios and identifies errors that tools like `biome`, `oxc`, and `eslint-plugin-react` can't.

## Public packages

Expand Down

0 comments on commit c47e8d5

Please sign in to comment.