Skip to content

Commit b660d1a

Browse files
committed
docs: update intro and contribution in README.md
1 parent a146b23 commit b660d1a

File tree

1 file changed

+6
-19
lines changed

1 file changed

+6
-19
lines changed

README.md

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,35 +9,22 @@
99
<p align="center"><img src="http://www.peachis.me/assets/vue-infinite-loading/demo.gif"></p>
1010

1111
## Intro
12-
This plugin is an infinite scroll plugin for Vue.js, it can help you create an infinite scroll list fastly.
12+
An infinite scroll plugin for Vue.js, it can help you impletement infinite scroll list more easily.
1313

1414
### Features
1515
- Mobile friendly
16-
- Compatible with any scrollable element
17-
- Diverse spinners as loading animation
18-
- Support result display after loading
19-
- Support two direction load
16+
- Internal spinners
17+
- 2-directions support
18+
- Load result message display
2019

2120
## Usage & Guide
2221
To check out live examples and docs, visit [Vue-infinite-loading GitHub Pages](https://peachscript.github.io/vue-infinite-loading/).
2322

2423
## Changelog
2524
Details changes for each release are documented in the [release notes](https://github.com/PeachScript/vue-infinite-loading/releases).
2625

27-
## Development Setup
28-
```bash
29-
# install dependencies
30-
npm install
31-
32-
# run dev-server
33-
npm run dev
34-
35-
# lint
36-
npm run lint
37-
38-
# test
39-
npm test
40-
```
26+
## Contribution
27+
Please make sure to read the [Contributing Guide](https://github.com/PeachScript/vue-infinite-loading/blob/master/.github/CONTRIBUTING.md) before making a pull request.
4128

4229
## Licence
4330
The MIT License (MIT)

0 commit comments

Comments
 (0)