Skip to content

Commit 90a71bf

Browse files
authored
docs: update README files to add badge and instructions (#20115)
* docs: update `README` files to enhance badge visibility and add more instructions * wip * wip: rename to x
1 parent 861c6da commit 90a71bf

File tree

3 files changed

+67
-10
lines changed

3 files changed

+67
-10
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
[Contribute to ESLint](https://eslint.org/docs/latest/contribute) |
1414
[Report Bugs](https://eslint.org/docs/latest/contribute/report-bugs) |
1515
[Code of Conduct](https://eslint.org/conduct) |
16-
[Twitter](https://twitter.com/geteslint) |
16+
[X](https://x.com/geteslint) |
1717
[Discord](https://eslint.org/chat) |
1818
[Mastodon](https://fosstodon.org/@eslint) |
1919
[Bluesky](https://bsky.app/profile/eslint.org)

packages/eslint-config-eslint/README.md

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,49 @@
1-
[![npm version][npm-image]][npm-url]
1+
[![npm version](https://img.shields.io/npm/v/eslint-config-eslint.svg)](https://www.npmjs.com/package/eslint-config-eslint)
2+
[![Downloads](https://img.shields.io/npm/dm/eslint-config-eslint.svg)](https://www.npmjs.com/package/eslint-config-eslint)
3+
[![Build Status](https://github.com/eslint/eslint/workflows/CI/badge.svg)](https://github.com/eslint/eslint/actions)
4+
<br>
5+
[![Open Collective Backers](https://img.shields.io/opencollective/backers/eslint)](https://opencollective.com/eslint)
6+
[![Open Collective Sponsors](https://img.shields.io/opencollective/sponsors/eslint)](https://opencollective.com/eslint)
27

38
# ESLint Configuration
49

5-
[Website](https://eslint.org) | [Configure ESLint](https://eslint.org/docs/latest/use/configure) | [Rules](https://eslint.org/docs/rules/) | [Contributing](https://eslint.org/docs/latest/contribute) | [Twitter](https://twitter.com/geteslint) | [Discord](https://eslint.org/chat) | [Mastodon](https://fosstodon.org/@eslint)
10+
[Website](https://eslint.org) |
11+
[Configure ESLint](https://eslint.org/docs/latest/use/configure) |
12+
[Rules](https://eslint.org/docs/rules/) |
13+
[Contribute to ESLint](https://eslint.org/docs/latest/contribute) |
14+
[Report Bugs](https://eslint.org/docs/latest/contribute/report-bugs) |
15+
[Code of Conduct](https://eslint.org/conduct) |
16+
[X](https://x.com/geteslint) |
17+
[Discord](https://eslint.org/chat) |
18+
[Mastodon](https://fosstodon.org/@eslint) |
19+
[Bluesky](https://bsky.app/profile/eslint.org)
620

721
Contains the ESLint configuration used for projects maintained by the ESLint team.
822

923
## Installation
1024

11-
You can install ESLint using npm:
25+
You can install ESLint using npm or other package managers:
1226

1327
```shell
14-
npm install eslint --save-dev
28+
npm install eslint -D
29+
# or
30+
yarn add eslint -D
31+
# or
32+
pnpm install eslint -D
33+
# or
34+
bun add eslint -D
1535
```
1636

1737
Then install this configuration:
1838

1939
```shell
20-
npm install eslint-config-eslint --save-dev
40+
npm install eslint-config-eslint -D
41+
# or
42+
yarn add eslint-config-eslint -D
43+
# or
44+
pnpm install eslint-config-eslint -D
45+
# or
46+
bun add eslint-config-eslint -D
2147
```
2248

2349
## Usage
@@ -87,6 +113,3 @@ export default defineConfig([eslintConfigESLint, eslintConfigESLintFormatting]);
87113
### Where to ask for help?
88114

89115
Open a [discussion](https://github.com/eslint/eslint/discussions) or stop by our [Discord server](https://eslint.org/chat) instead of filing an issue.
90-
91-
[npm-image]: https://img.shields.io/npm/v/eslint-config-eslint.svg?style=flat-square
92-
[npm-url]: https://www.npmjs.com/package/eslint-config-eslint

packages/js/README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,22 @@
11
[![npm version](https://img.shields.io/npm/v/@eslint/js.svg)](https://www.npmjs.com/package/@eslint/js)
2+
[![Downloads](https://img.shields.io/npm/dm/@eslint/js.svg)](https://www.npmjs.com/package/@eslint/js)
3+
[![Build Status](https://github.com/eslint/eslint/workflows/CI/badge.svg)](https://github.com/eslint/eslint/actions)
4+
<br>
5+
[![Open Collective Backers](https://img.shields.io/opencollective/backers/eslint)](https://opencollective.com/eslint)
6+
[![Open Collective Sponsors](https://img.shields.io/opencollective/sponsors/eslint)](https://opencollective.com/eslint)
27

38
# ESLint JavaScript Plugin
49

5-
[Website](https://eslint.org) | [Configure ESLint](https://eslint.org/docs/latest/use/configure) | [Rules](https://eslint.org/docs/rules/) | [Contributing](https://eslint.org/docs/latest/contribute) | [Twitter](https://twitter.com/geteslint) | [Chatroom](https://eslint.org/chat)
10+
[Website](https://eslint.org) |
11+
[Configure ESLint](https://eslint.org/docs/latest/use/configure) |
12+
[Rules](https://eslint.org/docs/rules/) |
13+
[Contribute to ESLint](https://eslint.org/docs/latest/contribute) |
14+
[Report Bugs](https://eslint.org/docs/latest/contribute/report-bugs) |
15+
[Code of Conduct](https://eslint.org/conduct) |
16+
[X](https://x.com/geteslint) |
17+
[Discord](https://eslint.org/chat) |
18+
[Mastodon](https://fosstodon.org/@eslint) |
19+
[Bluesky](https://bsky.app/profile/eslint.org)
620

721
The beginnings of separating out JavaScript-specific functionality from ESLint.
822

@@ -13,8 +27,28 @@ Right now, this plugin contains two configurations:
1327

1428
## Installation
1529

30+
You can install ESLint using npm or other package managers:
31+
32+
```shell
33+
npm install eslint -D
34+
# or
35+
yarn add eslint -D
36+
# or
37+
pnpm install eslint -D
38+
# or
39+
bun add eslint -D
40+
```
41+
42+
Then install this plugin:
43+
1644
```shell
1745
npm install @eslint/js -D
46+
# or
47+
yarn add @eslint/js -D
48+
# or
49+
pnpm install @eslint/js -D
50+
# or
51+
bun add @eslint/js -D
1852
```
1953

2054
## Usage

0 commit comments

Comments
 (0)