CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+<a name="1.0.2"></a>
+## [1.0.2](https://github.com/vue-a11y/vue-axe/compare/v1.0.1...v1.0.2) (2018-05-16)
+
+
+
 <a name="1.0.1"></a>
 ## [1.0.1](https://github.com/vue-a11y/vue-axe/compare/v1.0.0...v1.0.1) (2018-05-16)
 

README.md

@@ -1,5 +1,97 @@
 # vue-axe
 
+Accessibility auditing for Vue.js applications (Inspired by [dequelabs/react-axe](https://github.com/dequelabs/react-axe))
+
+## Install package
+#### NPM
+```shell
+npm install -D vue-axe
+```
+
+#### Yarn
+```shell
+yarn add -D vue-axe
+```
+---
+
+## Install plugin 
+```javascript
+import Vue from 'vue'
+import VueAxe from 'vue-axe'
+
+if (process.env.NODE_ENV !== 'production') {
+  Vue.use(VueAxe, {
+    config: {
+      // ...
+      rules: [
+        { id: 'heading-order', enabled: true },
+        { id: 'label-title-only', enabled: true },
+        // and more
+      ]
+    }
+  })
+  Vue.config.productionTip = false
+}
+```
+
+Optional: You can also pass settings through the second parameter at the time of installing the plugin, read about the object here:  
+https://github.com/dequelabs/axe-core/blob/master/doc/API.md#api-name-axeconfigure
+
+---
+
+## Using with HTML files
+#### CDN 
+```html
+<!-- Required Javascript -->
+<script src="https://unpkg.com/vue"></script>
+<script src="https://unpkg.com/vue-axe"></script>
+```
+
+```javascript
+Vue.use(VueAxe, {
+  config: {
+    // your configuration data
+  }
+})
+```
+
+---
+
+## Run the demo
+```shell
+git clone https://github.com/vue-a11y/vue-axe.git vue-axe-demo
+cd demo
+npm install
+npm run dev
+```
+
+It is a simple webpack template already installed and configured to run and check the logs in the browser console.  
+After the commands just access the http://localhost:8080/
+
+---
+
+## Run the tests
+```shell
+git clone https://github.com/vue-a11y/vue-axe.git vue-axe
+npm install
+npm run test 
+```
+
+Or run Cypress on interactive mode
+```shell
+npm run test:open
+```
+
 ---
 
-Accessibility auditing for Vue.js applications (Inspired by [dequelabs/react-axe](https://github.com/dequelabs/react-axe))
+## Contributing
+- Check the open issues or open a new issue to start a discussion around your feature idea or the bug you found;
+- Fork repository, make changes and send a pull request;
+
+If you want a faster communication, find me on [@ktquez](https://twitter.com/ktquez)
+And follow us on Twitter [@vue_a11y](https://twitter.com/vue_a11y)
+
+**thank you**
+
+
+

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue-axe",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Dynamic accessibility analysis for Vue.js using axe-core",
   "main": "dist/vue-axe.js",
   "scripts": {