From 09752c04fffcd765147b7841f5f8c3f04a91a88c Mon Sep 17 00:00:00 2001
From: Josh Thomas <jthoms1@gmail.com>
Date: Fri, 16 Nov 2018 11:51:50 -0500
Subject: [PATCH] Update documentation for the Vue Readme

---
 vue/README.md | 40 +++++++++++++++++++++++++++++++++++++---
 1 file changed, 37 insertions(+), 3 deletions(-)

diff --git a/vue/README.md b/vue/README.md
index 4897db8500..2afdf85a34 100644
--- a/vue/README.md
+++ b/vue/README.md
@@ -2,16 +2,50 @@
 
 Ionic Vue.js specific building blocks on top of [@ionic/core](https://www.npmjs.com/package/@ionic/core) components.
 
+To get started simply install `@ionic/vue` with npm into your project and then register it as a plugin to your vue application.
+  
+```ts
+import Vue from 'vue';
+import Ionic from '@ionic/vue';
+
+Vue.use(Ionic);
+
+new Vue({
+  router,
+  store,
+  render: h => h(App)
+}).$mount('#app');
+```
+
+## Publishing a Native Application
+
+You can now make use of all of the ionic components in your vue application.
+If you want to publish your app to the App Store or Google Play you will need to use the ionic cli to execute Capacitor commands to do so.
+
+More information on this can be found here. https://beta.ionicframework.com/docs/cli
+If you want to learn more about Capacitor our dedicated site can be found here. https://capacitor.ionicframework.com/
+
+The commands that you will need to execute are below.
+```sh
+ionic capacitor add
+ionic capacitor copy
+ionic capacitor run
+```
+
+
+## Current known limitations
+
+This is an alpha release of @ionic/vue so please understand that there are some missing pieces but know that many of the componets will work.
+* The shorthand `v-model` binding is currently not supported
+* Stack navigation for deep transitions is under heavy development at this time.
 
 ## Related
 
 * [Ionic Core Components](https://www.npmjs.com/package/@ionic/core)
-* [Ionic Documentation](https://ionicframework.com/docs/)
+* [Ionic Documentation](https://beta.ionicframework.com/docs/)
 * [Ionic Worldwide Slack](http://ionicworldwide.herokuapp.com/)
 * [Ionic Forum](https://forum.ionicframework.com/)
 * [Ionicons](http://ionicons.com/)
-* [Stencil](https://stenciljs.com/)
-* [Stencil Worldwide Slack](https://stencil-worldwide.herokuapp.com/)
 * [Capacitor](https://capacitor.ionicframework.com/)