Skip to content

Commit b86b776

Browse files
committed
📝 docs(README): update docs
1 parent 04497da commit b86b776

File tree

2 files changed

+36
-31
lines changed

2 files changed

+36
-31
lines changed

README.md

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,47 @@
1-
# eslint-plugin-vue-i18n
1+
# :globe_with_meridians: eslint-plugin-vue-i18n
22

3-
ESLint plugin for vue-i18n
3+
ESLint plugin for Vue I18n
44

5-
## Installation
5+
<a href="https://www.patreon.com/kazupon" target="_blank">
6+
<img src="https://c5.patreon.com/external/logo/become_a_patron_button.png" alt="Become a Patreon">
7+
</a>
68

7-
You'll first need to install [ESLint](http://eslint.org):
9+
## :cd: Installation
810

9-
```
10-
$ npm i eslint --save-dev
11-
```
12-
13-
Next, install `eslint-plugin-vue-i18n`:
11+
Use [npm](https://www.npmjs.com/) or a compatible tool.
1412

15-
```
16-
$ npm install eslint-plugin-vue-i18n --save-dev
13+
```sh
14+
npm install --save-dev eslint eslint-plugin-vue-i18n
1715
```
1816

19-
**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-vue-i18n` globally.
17+
## :rocket: Usage
2018

21-
## Usage
19+
Configure your `.eslintrc.*` file.
2220

23-
Add `vue-i18n` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
21+
For example:
2422

2523
```json
2624
{
27-
"plugins": [
28-
"vue-i18n"
29-
]
25+
"extends": [
26+
"eslint:recommended",
27+
"plugin:vue-i18n/recommended"
28+
],
29+
"rules": {
30+
// Optional.
31+
"vue-i18n/no-dynamic-key": "error"
32+
}
3033
}
3134
```
3235

36+
## :white_check_mark: TODO
37+
- [x] no-missing-key
38+
- [ ] no-dynamic-key
39+
- [ ] no-unused-key
40+
- [ ] no-raw-text
41+
- [ ] valid-message-syntax
42+
- [ ] keys-order
43+
- [ ] replace documentation example with `eslint-playground` component
3344

34-
Then configure the rules you want to use under the rules section.
35-
36-
```json
37-
{
38-
"rules": {
39-
"vue-i18n/rule-name": 2
40-
}
41-
}
42-
```
43-
44-
## Supported Rules
45+
## :copyright: License
4546

46-
* Fill in provided rules here
47+
[MIT](http://opensource.org/licenses/MIT)

docs/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Getting Started
22

3+
<a href="https://www.patreon.com/kazupon" target="_blank">
4+
<img src="https://c5.patreon.com/external/logo/become_a_patron_button.png" alt="Become a Patreon">
5+
</a>
6+
37
## :cd: Installation
48

59
Use [npm](https://www.npmjs.com/) or a compatible tool.
@@ -22,7 +26,7 @@ For example:
2226
],
2327
"rules": {
2428
// Optional.
25-
"vue-i18n/no-missing-key": "error"
29+
"vue-i18n/no-dynamic-key": "error"
2630
}
2731
}
28-
```
32+
```

0 commit comments

Comments
 (0)