Skip to content

Commit bb28074

Browse files
authored
DOCS: update READMEs (vuejs#392)
1 parent c971bad commit bb28074

File tree

3 files changed

+89
-13
lines changed

3 files changed

+89
-13
lines changed

README.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Vue Test Utils [![Build Status](https://circleci.com/gh/vuejs/vue-test-utils/tree/dev.png?style=shield)](https://circleci.com/gh/vuejs/vue-test-utils)
2+
3+
## Currently in beta
4+
To use Vue Test Utils beta:
5+
```
6+
// npm
7+
npm install --save-dev @vue/test-utils
8+
9+
// yarn
10+
yarn add --dev @vue/test-utils
11+
```
12+
13+
## Intro
14+
15+
Vue Test Utils is the official test library for [Vue.js](http://vuejs.org). It provides methods for unit testing Vue components.
16+
17+
## Documentation
18+
19+
Refer to the [documentation](https://vue-test-utils.vuejs.org/)
20+
21+
## Examples
22+
23+
- [example with Jest](https://github.com/vuejs/vue-test-utils-jest-example)
24+
- [example with Mocha](https://github.com/vuejs/vue-test-utils-mocha-webpack-example)
25+
- [example with tape](https://github.com/eddyerburgh/vue-test-utils-tape-example)
26+
- [example with AVA](https://github.com/eddyerburgh/vue-test-utils-ava-example)
27+
28+
## Questions
29+
30+
For questions and support please use the [Discord chat room](https://vue-land.js.org/), [Gitter chat room](https://gitter.im/vuejs/vue), or [the official forum](http://forum.vuejs.org). The issue list of this repo is **exclusively** for bug reports and feature requests.
31+
32+
## Issues
33+
34+
Please make sure to read the [Issue Reporting Checklist](https://github.com/vuejs/vue/blob/dev/.github/CONTRIBUTING.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines may be closed immediately.
35+
36+
## Contribution
37+
38+
Please make sure to read the [Contributing Guide](https://github.com/vuejs/vue/blob/dev/.github/CONTRIBUTING.md) before making a pull request.
39+
40+
## Changelog
41+
42+
Changes for each release are documented in the [release notes](https://github.com/vuejs/vue-test-utils/releases).
43+
44+
## Stay In Touch
45+
46+
For the latest releases and announcements, follow on Twitter: [@vuejs](https://twitter.com/vuejs)
47+
48+
## License
49+
50+
[MIT](http://opensource.org/licenses/MIT)

packages/server-test-utils/README.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Vue Server Test Utils [![Build Status](https://circleci.com/gh/vuejs/vue-test-utils/tree/dev.png?style=shield)](https://circleci.com/gh/vuejs/vue-test-utils)
2+
3+
## Currently in beta
4+
To use Vue Server Test Utils beta:
5+
```
6+
// npm
7+
npm install --save-dev @vue/server-test-utils
8+
9+
// yarn
10+
yarn add --dev @vue/server-test-utils
11+
```
12+
13+
## Intro
14+
15+
Vue Server Test Utils is the official test library for [Vue.js](http://vuejs.org). It provides methods for unit testing Vue components.
16+
17+
## Documentation
18+
19+
Refer to [documentation](https://vue-test-utils.vuejs.org/)
20+
21+
## Examples
22+
23+
- [example with Jest](https://github.com/vuejs/vue-test-utils-jest-example)
24+
- [example with Mocha](https://github.com/vuejs/vue-test-utils-mocha-webpack-example)
25+
- [example with tape](https://github.com/eddyerburgh/vue-test-utils-tape-example)
26+
- [example with AVA](https://github.com/eddyerburgh/vue-test-utils-ava-example)
27+
28+
## Questions
29+
30+
For questions and support please use the [Discord chat room](https://vue-land.js.org/), [Gitter chat room](https://gitter.im/vuejs/vue), or [the official forum](http://forum.vuejs.org). The issue list of this repo is **exclusively** for bug reports and feature requests.
31+
32+
## Issues
33+
34+
Please make sure to read the [Issue Reporting Checklist](https://github.com/vuejs/vue/blob/dev/.github/CONTRIBUTING.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines may be closed immediately.
35+
36+
## License
37+
38+
[MIT](http://opensource.org/licenses/MIT)

packages/test-utils/README.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Vue Test Utils is the official test library for [Vue.js](http://vuejs.org). It p
1616

1717
## Documentation
1818

19-
Refer to [documentation](https://vue-test-utils.vuejs.org/)
19+
Refer to the [documentation](https://vue-test-utils.vuejs.org/)
2020

2121
## Examples
2222

@@ -33,18 +33,6 @@ For questions and support please use the [Discord chat room](https://vue-land.js
3333

3434
Please make sure to read the [Issue Reporting Checklist](https://github.com/vuejs/vue/blob/dev/.github/CONTRIBUTING.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines may be closed immediately.
3535

36-
## Contribution
37-
38-
Please make sure to read the [Contributing Guide](https://github.com/vuejs/vue/blob/dev/.github/CONTRIBUTING.md) before making a pull request. If you have a Vue-related project/component/tool, add it with a pull-request to [this curated list](https://github.com/vuejs/awesome-vue)!
39-
40-
## Changelog
41-
42-
Details changes for each release are documented in the [release notes](https://github.com/vuejs/vue-test-utils/releases).
43-
44-
## Stay In Touch
45-
46-
For the latest releases and announcements, follow on Twitter: [@vuejs](https://twitter.com/vuejs)
47-
4836
## License
4937

5038
[MIT](http://opensource.org/licenses/MIT)

0 commit comments

Comments
 (0)