Skip to content

Commit b018309

Browse files
authored
Merge pull request #24 from vuejs/update-readme
Add "attention" section about beta release
2 parents 55583c3 + 948a9ed commit b018309

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,23 @@
66

77
> Official ESLint plugin for Vue.js
88
9-
## :exclamation: Requirements
9+
## :exclamation: Attention - this is documentation for beta `3.0.0` :exclamation:
10+
11+
This branch contains `eslint-plugin-vue@beta` which is pre-released `3.0`, but it's not the default version that you get with `npm install eslint-plugin-vue`. In order to install this you need to specify either `"eslint-plugin-vue": "beta"` in `package.json` or do `npm install eslint-plugin-vue@beta`.
12+
13+
Please try it and report any issues that you might experience.
14+
15+
If you want to check previous releases [go here](https://github.com/vuejs/eslint-plugin-vue/releases).
16+
17+
## :grey_exclamation: Requirements
1018

1119
- [ESLint](http://eslint.org/) `>=3.18.0`.
1220
- Node.js `>=4.0.0`
1321

1422
## :cd: Installation
1523

1624
```
17-
npm install --save-dev eslint eslint-plugin-vue
25+
npm install --save-dev eslint eslint-plugin-vue@beta
1826
```
1927

2028
## :rocket: Usage

0 commit comments

Comments
 (0)