Skip to content

Commit c27dd2e

Browse files
committed
📝 docs(README): updates
1 parent e674a50 commit c27dd2e

File tree

2 files changed

+8
-26
lines changed

2 files changed

+8
-26
lines changed

README.md

Lines changed: 2 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -8,32 +8,9 @@ ESLint plugin for Vue I18n
88
<img src="https://c5.patreon.com/external/logo/become_a_patron_button.png" alt="Become a Patreon">
99
</a>
1010

11-
## :cd: Installation
11+
## :book: Documentation
1212

13-
Use [npm](https://www.npmjs.com/) or a compatible tool.
14-
15-
```sh
16-
npm install --save-dev eslint eslint-plugin-vue-i18n
17-
```
18-
19-
## :rocket: Usage
20-
21-
Configure your `.eslintrc.*` file.
22-
23-
For example:
24-
25-
```json
26-
{
27-
"extends": [
28-
"eslint:recommended",
29-
"plugin:vue-i18n/recommended"
30-
],
31-
"rules": {
32-
// Optional.
33-
"vue-i18n/no-dynamic-key": "error"
34-
}
35-
}
36-
```
13+
See [here](https://kazupon.github.io/eslint-plugin-vue-i18n/)
3714

3815
## :scroll: Changelog
3916
Details changes for each release are documented in the [CHANGELOG.md](https://github.com/kazupon/eslint-plugin-vue-i18n/blob/master/CHANGELOG.md).

docs/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Configure your `.eslintrc.*` file.
1818

1919
For example:
2020

21-
```json
21+
```js
2222
{
2323
"extends": [
2424
"eslint:recommended",
@@ -27,6 +27,11 @@ For example:
2727
"rules": {
2828
// Optional.
2929
"vue-i18n/no-dynamic-key": "error"
30+
},
31+
"settings": {
32+
"vue-i18n": {
33+
"localeDir": "./pato/to/locales/*.json" // extention is glob formatting!
34+
}
3035
}
3136
}
3237
```

0 commit comments

Comments
 (0)