Skip to content

Commit d03408c

Browse files
authored
Update docs (#59)
1 parent 4b0863c commit d03408c

File tree

3 files changed

+28
-14
lines changed

3 files changed

+28
-14
lines changed

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,23 @@
1212
[![Build Status](https://github.com/ota-meshi/eslint-plugin-regexp/workflows/CI/badge.svg?branch=master)](https://github.com/ota-meshi/eslint-plugin-regexp/actions?query=workflow%3ACI)
1313
[![Coverage Status](https://coveralls.io/repos/github/ota-meshi/eslint-plugin-regexp/badge.svg?branch=master)](https://coveralls.io/github/ota-meshi/eslint-plugin-regexp?branch=master)
1414

15-
## Features
15+
## :name_badge: Features
1616

1717
This ESLint plugin provides linting rules relate to better ways to help you avoid problems when using RegExp.
1818

19+
- Find the wrong usage of regular expressions, and their hints.
20+
- Enforces a consistent style of regular expressions.
21+
- Find hints for writing optimized regular expressions.
22+
1923
You can check on the [Online DEMO](https://ota-meshi.github.io/eslint-plugin-regexp/playground/).
2024

2125
<!--DOCS_IGNORE_START-->
2226

23-
## Documentation
27+
## :book: Documentation
2428

2529
See [documents](https://ota-meshi.github.io/eslint-plugin-regexp/).
2630

27-
## Installation
31+
## :cd: Installation
2832

2933
```bash
3034
npm install --save-dev eslint eslint-plugin-regexp
@@ -37,7 +41,7 @@ npm install --save-dev eslint eslint-plugin-regexp
3741
3842
<!--DOCS_IGNORE_END-->
3943

40-
## Usage
44+
## :book: Usage
4145

4246
<!--USAGE_SECTION_START-->
4347

@@ -59,7 +63,7 @@ module.exports = {
5963
}
6064
```
6165

62-
## Configs
66+
### Configuration
6367

6468
This plugin provides one config:
6569

@@ -68,7 +72,7 @@ This plugin provides one config:
6872

6973
<!--USAGE_SECTION_END-->
7074

71-
## Rules
75+
## :white_check_mark: Rules
7276

7377
<!--RULES_SECTION_START-->
7478

@@ -117,7 +121,11 @@ The rules with the following star :star: are included in the `plugin:regexp/reco
117121

118122
<!--DOCS_IGNORE_START-->
119123

120-
## Contributing
124+
<!-- ## :traffic_light: Semantic Versioning Policy
125+
126+
**eslint-plugin-jsonc** follows [Semantic Versioning](http://semver.org/) and [ESLint's Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy). -->
127+
128+
## :beers: Contributing
121129

122130
Welcome contributing!
123131

@@ -130,6 +138,6 @@ Please use GitHub's Issues/PRs.
130138

131139
<!--DOCS_IGNORE_END-->
132140

133-
## License
141+
## :lock: License
134142

135143
See the [LICENSE](LICENSE) file for license rights and limitations (MIT).

docs/README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,24 @@
1212
[![Build Status](https://github.com/ota-meshi/eslint-plugin-regexp/workflows/CI/badge.svg?branch=master)](https://github.com/ota-meshi/eslint-plugin-regexp/actions?query=workflow%3ACI)
1313
[![Coverage Status](https://coveralls.io/repos/github/ota-meshi/eslint-plugin-regexp/badge.svg?branch=master)](https://coveralls.io/github/ota-meshi/eslint-plugin-regexp?branch=master)
1414

15-
## Features
15+
## :name_badge: Features
1616

1717
This ESLint plugin provides linting rules relate to better ways to help you avoid problems when using RegExp.
1818

19+
- Find the wrong usage of regular expressions, and their hints.
20+
- Enforces a consistent style of regular expressions.
21+
- Find hints for writing optimized regular expressions.
22+
1923
You can check on the [Online DEMO](./playground/).
2024

21-
## Usage
25+
## :book: Usage
2226

2327
See [User Guide](./user-guide/README.md).
2428

25-
## Rules
29+
## :white_check_mark: Rules
2630

2731
See [Available Rules](./rules/README.md).
2832

29-
## License
33+
## :lock: License
3034

3135
See the [LICENSE](LICENSE) file for license rights and limitations (MIT).

docs/user-guide/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
11
# User Guide
22

3-
## Installation
3+
## :cd: Installation
44

55
```bash
66
npm install --save-dev eslint eslint-plugin-regexp
77
```
88

99
::: tip Requirements
10+
1011
- ESLint v6.0.0 and above
1112
- Node.js v8.10.0 and above
13+
1214
:::
1315

14-
## Usage
16+
## :book: Usage
1517

1618
### Configuration
1719

0 commit comments

Comments
 (0)