Merge pull request #48 from eddyerburgh/dev

Docs update

Author: yyx990803

README.md

@@ -17,8 +17,9 @@ Refer to [documentation](https://vuejs.github.io/vue-test-utils/)
 ## Examples
 
 - [example with Jest](https://github.com/eddyerburgh/vue-test-utils-jest-example)
-- [example with AVA](https://github.com/eddyerburgh/vue-test-utils-ava-example)
+- [example with Mocha](https://github.com/eddyerburgh/vue-test-utils-mocha-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
 

docs/en/README.md

@@ -1,5 +1,35 @@
-# vue-test-utils
+# Vue Test Utils
 
-vue-test-utils is the official test library for Vue.js. It provides methods for unit testing Vue components.
+Vue Test Utils is the official test library for Vue.js. 
 
-[Documentation Summary](SUMMARY.md)
+It provides methods for [unit testing](guides/introduction-to-unit-tests.md) Vue components.
+
+## Example
+
+```js
+import { mount } from 'vue-test-utils'
+import Counter from './Counter.vue'
+
+const wrapper = mount(Counter)
+wrapper.find('button').trigger('click')
+expect(wrapper.text()).toContain('1')
+```
+
+
+## Getting started
+
+To get started using Vue Test Utils, please see [using with jest](guides/using-with-jest.md).
+
+If you're new to unit testing, you can read our [introduction to unit tests](guides/introduction-to-unit-tests.md).
+
+## Testing single file components (SFCs)
+
+- [Testing SFCs with Jest](guides/testing-SFCs-with-jest.md)
+- [Testing SFCs with Mocha](guides/testing-SFCs-with-mocha-webpack.md)
+
+## Example projects
+
+- [example with Jest](https://github.com/eddyerburgh/vue-test-utils-jest-example)
+- [example with Mocha](https://github.com/eddyerburgh/vue-test-utils-mocha-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)

docs/en/SUMMARY.md

@@ -36,5 +36,12 @@
     * [setData](api/wrapper-array/setData.md)
     * [setProps](api/wrapper-array/setProps.md)
     * [trigger](api/wrapper-array/trigger.md)
-  * [selectors](api/selectors.md)
-  * [common gotchas](common-gotchas.md)
+  * [Selectors](api/selectors.md)
+  * [Guides](guides/README.md)
+    * [Introduction to unit tests](guides/introduction-to-unit-tests.md)
+    * [Choosing a test runner](guides/choosing-a-test-runner.md)
+    * [Using with Jest](guides/using-with-jest.md)
+    * [Testing SFCs with Jest](guides/testing-SFCs-with-jest.md)
+    * [Testing SFCs with Mocha](guides/testing-SFCs-with-mocha-webpack.md)
+    * [Using with Vuex](guides/using-with-vuex.md)  
+  * [Common gotchas](common-gotchas.md)

docs/en/api/README.md

@@ -1,3 +1,7 @@
-## [mount](/docs/en/api/mount.md)
-## [shallow](/docs/en/api/shallow.md)
-## [selectors](/docs/en/api/selectors.md)
+# API
+
+## [mount](api/mount.md)
+## [shallow](shallow.md)
+## [options](options.md)
+## [createLocalVue](createLocalVue.md)
+## [selectors](selectors.md)

docs/en/api/createLocalVue.md

@@ -25,4 +25,4 @@ const freshWrapper = shallow(Foo)
 expect(freshWrapper.vm.foo).to.equal(false)
 ```
 
-- **See also:** [Common Gotchas](/en/common-gotchas.md)
+- **See also:** [Common Gotchas](common-gotchas.md)

docs/en/api/mount.md

@@ -9,13 +9,13 @@
 
 - **Options:**
 
-See [options](/docs/en/api/options.md)
+See [options](options.md)
 
 - **Usage:**
 
-Returns [`Wrapper`](/docs/en/api/wrapper/README.md) of first DOM node or Vue component matching selector.
+Returns [`Wrapper`](wrapper/README.md) of first DOM node or Vue component matching selector.
 
-Use any valid [selector](/docs/en/api/selectors.md).
+Use any valid [selector](selectors.md).
 
 **Without options:**
 
@@ -133,4 +133,4 @@ describe('Foo', () => {
 })
 ```
 
-- **See also:** [Wrapper](/docs/en/api/wrapper/README.md)
+- **See also:** [Wrapper](wrapper/README.md)

docs/en/api/options.md

@@ -22,7 +22,7 @@ Vue options are passed to the component when a new instance is created. , e.g. `
 
 `options` (`Object`): a Vue options object. Vue options are passed to the component when a new instance is created. , e.g. `store`, `propsData`. For full list, see the [Vue API](https://vuejs.org/v2/api/). Also takes vue-test-utils options:
 
-`options.attachToDocument` (`boolean`): Component will attach to DOM when rendered. This can be used with [`hasStyle`](/docs/en/api/wrapper/hasStyle.md) to check multi element CSS selectors
+`options.attachToDocument` (`boolean`): Component will attach to DOM when rendered. This can be used with [`hasStyle`](wrapper/hasStyle.md) to check multi element CSS selectors
 
 `options.attrs` (`Object`): Attrs object to pass to component.
 
@@ -34,7 +34,7 @@ Vue options are passed to the component when a new instance is created. , e.g. `
 
 `options.intercept` (`Object`): Add globals to Vue instance.
 
-`options.localVue` (`Object`): vue class to use in `mount`. See [createLocalVue](/docs/en/api/createLocalVue.md)
+`options.localVue` (`Object`): vue class to use in `mount`. See [createLocalVue](createLocalVue.md)
 
 `options.propsData` (`Object`): Data for props in component
 

docs/en/api/wrapper-array/README.md

@@ -1,6 +1,6 @@
 # WrapperArray
 
-A `WrapperArray` is an object that contains an array of [Wrappers](/docs/en/api/wrapper/README.md), and methods to test the `Wrappers`.
+A `WrapperArray` is an object that contains an array of [Wrappers](../wrapper/README.md), and methods to test the `Wrappers`.
 
 - **Properties:**
 

docs/en/api/wrapper-array/at.md

@@ -1,13 +1,15 @@
 # at(index)
 
+- **Usage:**
+
+Returns `Wrapper` at `index` passed. Uses zero based numbering (i.e. first item is at index 0).
+
 - **Arguments:**
   - `{number} index`
 
 - **Returns:** `{Wrapper}`
 
-- **Usage:**
-
-Returns `Wrapper` at `index` passed. Uses zero based numbering (i.e. first item is at index 0).
+- **Example:**
 
 ```js
 import { shallow } from 'vue-test-utils'

docs/en/api/wrapper-array/contains.md

@@ -1,15 +1,17 @@
 # contains(selector)
 
+- **Usage:**
+
+Assert every wrapper in `WrapperArray` contains selector. 
+
+Use any valid [selector](../selectors.md).
+
 - **Arguments:**
   - `{string|Component} selector`
 
 - **Returns:** `{boolean}`
 
-- **Usage:**
-
-Assert every wrapper in `WrapperArray` contains selector. 
-
-Use any valid [selector](/docs/en/api/selectors.md).
+- **Example:**
 
 ```js
 import { shallow } from 'vue-test-utils'