Skip to content

docs: add packages section to README.md #503

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 30, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
# 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
## Packages

// yarn
yarn add --dev @vue/test-utils
```
This repository provides the following two packages.
They are currently in beta.

* [Vue Test Utils](./packages/test-utils)
* [Vue Server Test Utils](./packages/server-test-utils)

## Intro
You can install these packages by the following command.

Vue Test Utils is the official test library for [Vue.js](http://vuejs.org). It provides methods for unit testing Vue components.
```
npm install --save-dev @vue/test-utils
npm install --save-dev @vue/server-test-utils
```

## Documentation

Expand Down