diff --git a/README.md b/README.md new file mode 100644 index 000000000..bb935e50b --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +# 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) + +## Currently in beta +To use Vue Test Utils beta: +``` +// npm +npm install --save-dev @vue/test-utils + +// yarn +yarn add --dev @vue/test-utils +``` + +## Intro + +Vue Test Utils is the official test library for [Vue.js](http://vuejs.org). It provides methods for unit testing Vue components. + +## Documentation + +Refer to the [documentation](https://vue-test-utils.vuejs.org/) + +## Examples + +- [example with Jest](https://github.com/vuejs/vue-test-utils-jest-example) +- [example with Mocha](https://github.com/vuejs/vue-test-utils-mocha-webpack-example) +- [example with tape](https://github.com/eddyerburgh/vue-test-utils-tape-example) +- [example with AVA](https://github.com/eddyerburgh/vue-test-utils-ava-example) + +## Questions + +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. + +## Issues + +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. + +## Contribution + +Please make sure to read the [Contributing Guide](https://github.com/vuejs/vue/blob/dev/.github/CONTRIBUTING.md) before making a pull request. + +## Changelog + +Changes for each release are documented in the [release notes](https://github.com/vuejs/vue-test-utils/releases). + +## Stay In Touch + +For the latest releases and announcements, follow on Twitter: [@vuejs](https://twitter.com/vuejs) + +## License + +[MIT](http://opensource.org/licenses/MIT) diff --git a/packages/server-test-utils/README.md b/packages/server-test-utils/README.md new file mode 100644 index 000000000..ce79db269 --- /dev/null +++ b/packages/server-test-utils/README.md @@ -0,0 +1,38 @@ +# 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) + +## Currently in beta +To use Vue Server Test Utils beta: +``` +// npm +npm install --save-dev @vue/server-test-utils + +// yarn +yarn add --dev @vue/server-test-utils +``` + +## Intro + +Vue Server Test Utils is the official test library for [Vue.js](http://vuejs.org). It provides methods for unit testing Vue components. + +## Documentation + +Refer to [documentation](https://vue-test-utils.vuejs.org/) + +## Examples + +- [example with Jest](https://github.com/vuejs/vue-test-utils-jest-example) +- [example with Mocha](https://github.com/vuejs/vue-test-utils-mocha-webpack-example) +- [example with tape](https://github.com/eddyerburgh/vue-test-utils-tape-example) +- [example with AVA](https://github.com/eddyerburgh/vue-test-utils-ava-example) + +## Questions + +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. + +## Issues + +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. + +## License + +[MIT](http://opensource.org/licenses/MIT) diff --git a/packages/test-utils/README.md b/packages/test-utils/README.md index aad6cbded..ad40d9322 100644 --- a/packages/test-utils/README.md +++ b/packages/test-utils/README.md @@ -16,7 +16,7 @@ Vue Test Utils is the official test library for [Vue.js](http://vuejs.org). It p ## Documentation -Refer to [documentation](https://vue-test-utils.vuejs.org/) +Refer to the [documentation](https://vue-test-utils.vuejs.org/) ## Examples @@ -33,18 +33,6 @@ For questions and support please use the [Discord chat room](https://vue-land.js 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. -## Contribution - -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)! - -## Changelog - -Details changes for each release are documented in the [release notes](https://github.com/vuejs/vue-test-utils/releases). - -## Stay In Touch - -For the latest releases and announcements, follow on Twitter: [@vuejs](https://twitter.com/vuejs) - ## License [MIT](http://opensource.org/licenses/MIT)