Skip to content

Commit 477951e

Browse files
committed
docs(readme): update
1 parent cebc981 commit 477951e

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

readme.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# eslint-plugin-stylefix
1+
# eslint-plugin-zss-lint
22

3-
![NPM Version](https://img.shields.io/npm/v/eslint-plugin-stylefix?color=brightgreen)
4-
![NPM License](https://img.shields.io/npm/l/eslint-plugin-stylefix?color=blue)
3+
![NPM Version](https://img.shields.io/npm/v/eslint-plugin-zss-lint?color=brightgreen)
4+
![NPM License](https://img.shields.io/npm/l/eslint-plugin-zss-lint?color=blue)
55

66
ESlint plugin for style fixing and error detection.
77

@@ -13,19 +13,19 @@ You'll first need to install [ESLint](https://eslint.org/):
1313
npm i eslint --save-dev
1414
```
1515

16-
Next install `eslint-plugin-stylefix`:
16+
Next install `eslint-plugin-zss-lint`:
1717

1818
```sh
19-
npm i --save-dev eslint-plugin-stylefix
19+
npm i --save-dev eslint-plugin-zss-lint
2020
```
2121

2222
## Usage
2323

24-
Add stylefix to the plugins section of your `.eslintrc` configuration file. You can omit the eslint-plugin- prefix:
24+
Add zss-lint to the plugins section of your `.eslintrc` configuration file. You can omit the eslint-plugin- prefix:
2525

2626
```json
2727
{
28-
"plugins": ["stylefix"]
28+
"plugins": ["zss-lint"]
2929
}
3030
```
3131

@@ -35,7 +35,7 @@ As for the recommended rules two rules will be enabled with the sort-properties
3535

3636
```json
3737
"extends": [
38-
"plugin:stylefix/recommended"
38+
"plugin:zss-lint/recommended"
3939
]
4040
```
4141

@@ -46,8 +46,8 @@ If you want to set security levels individually set them in the rules.
4646
```json
4747
{
4848
"rules": {
49-
"stylefix/sort-properties": "warn",
50-
"stylefix/validate-values": "warn"
49+
"zss-lint/sort-properties": "warn",
50+
"zss-lint/validate-values": "warn"
5151
}
5252
}
5353
```
@@ -70,12 +70,12 @@ The following file is a configuration file that contains recommended settings fo
7070
```js
7171
import eslint from '@eslint/js'
7272
import tseslint from 'typescript-eslint'
73-
import stylefixlint from 'eslint-plugin-stylefix'
73+
import zsslint from 'eslint-plugin-zss-lint'
7474

7575
const eslintConfig = tseslint.config(
7676
eslint.configs.recommended
7777
...tseslint.configs.strict
78-
stylefixlint.flatConfigs.recommended
78+
zsslint.flatConfigs.recommended
7979
{
8080
files: ['**/*.{ts,tsx}']
8181
}
@@ -84,7 +84,7 @@ const eslintConfig = tseslint.config(
8484
export default eslintConfig
8585
```
8686

87-
## Rule Description
87+
## Rules Description
8888

8989
### sort-properties
9090

@@ -117,4 +117,4 @@ Validation includes other standard properties.
117117

118118
## License
119119

120-
MIT.
120+
eslint-plugin-zss-lint is [MIT licensed](https://github.com/zss-in-js/plumeria/blob/main/license).

0 commit comments

Comments
 (0)