Skip to content

Commit 8993c56

Browse files
committed
Docs: update README.md
1 parent b3efa21 commit 8993c56

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,37 @@
11
# vue-eslint-demo
2-
The online demo to check `eslint-plugin-vue`.
2+
3+
The online demo to check [eslint-plugin-vue](https://github.com/vuejs/eslint-plugin-vue#readme).
4+
5+
## ⤴️ Motivation
6+
7+
- Let's make the reproduce code/config of bugs. It would help issue handling.
8+
9+
## 💿 Installation
10+
11+
Open https://mysticatea.github.io/vue-eslint-demo/
12+
13+
- It does not support browsers which don't support ES2015.
14+
15+
## 📖 Usage
16+
17+
- Choose rules in sidebar to enable.
18+
- Input code the center area.
19+
- Right area shows the result of `eslint --fix`.
20+
- Bottom area shows the error list.
21+
22+
## 📰 Changelog
23+
24+
- [GitHub Releases](https://github.com/mysticatea/vue-eslint-demo/releases)
25+
26+
## 🍻 Contributing
27+
28+
Welcome contributing!
29+
30+
Please use GitHub's Issues/PRs.
31+
32+
### Development Tools
33+
34+
- `npm run build` builds the app into `/dist` directory.
35+
- `npm run clean` removes `/dist` directory.
36+
- `npm run deploy` builds the app, then updates `gh-pages` branch, then pushes it to GitHub.
37+
- `npm run watch` runs the app with `webpack-dev-server`.

0 commit comments

Comments
 (0)