chore(): add vue and vue-router readmes (#22316)

ionic-team · Oct 14, 2020 · 05b5557 · 05b5557
1 parent 6be8b8d
commit 05b5557
Show file tree

Hide file tree

Showing 3 changed files with 78 additions and 0 deletions.
diff --git a/packages/vue-router/README.md b/packages/vue-router/README.md
@@ -0,0 +1,31 @@
+# @ionic/vue-router
+
+Routing integration for `@ionic/vue` applications.
+
+## Building
+
+1. Install dependencies:
+
+```shell
+npm install
+```
+
+2. Run build script:
+
+```shell
+npm run build
+````
+
+## Tests
+
+* Tests are found in the `__tests__` directory and use Jest.
+* Tests can be run using `npm run test.spec`
+* Bug fix and feature PRs should have new tests verifying the PR functionality.
+
+## Contributing
+
+See our [Contributing Guide](https://github.com/ionic-team/ionic-framework/blob/master/.github/CONTRIBUTING.md).
+
+## Need Help?
+
+Post your question on the [Ionic Forum](http://forum.ionicframework.com/).
diff --git a/packages/vue/CHANGELOG.md b/packages/vue/CHANGELOG.md
@@ -1,5 +1,7 @@
 # Ionic Vue
 
+> This file contains the changelog for the Ionic Vue beta. For the latest changes, see our [main changelog file](https://github.com/ionic-team/ionic-framework/blob/master/CHANGELOG.md).
+
 ## 0.5.2
 
 ### Bug Fixes

diff --git a/packages/vue/README.md b/packages/vue/README.md
@@ -0,0 +1,45 @@
+# @ionic/vue
+
+Ionic Framework integration for Vue 3 apps.
+
+## Building
+
+1. Install dependencies in `@ionic/core`:
+
+```shell
+cd core && npm install
+```
+
+2. Build `@ionic/core`. This will generate Vue component bindings in the `packages/vue` directory:
+
+```shell
+npm run build
+````
+
+3. Install dependencies in `@ionic/vue`:
+
+```shell
+cd packages/vue && npm install
+```
+
+2. Build `@ionic/vue`:
+
+```shell
+npm run build
+````
+
+## Tests
+
+* E2E Tests are found in the `packages/vue/test-app/tests` directory and use Cypress.
+* When making changes to `@ionic/vue` or `@ionic/vue-router` you can run `npm run sync` in the `test-app` directory to ensure that the test application is using your built changes. Be sure to build in the `vue` and `vue-router` directories first.
+* Tests can be run in headless mode by running `npm run cypress`.
+* If you want to open the Cypress test runner, you can run `node_modules/.bin/cypress open`.
+* Bug fix and feature PRs should have new tests verifying the PR functionality.
+
+## Contributing
+
+See our [Contributing Guide](https://github.com/ionic-team/ionic-framework/blob/master/.github/CONTRIBUTING.md).
+
+## Need Help?
+
+Post your question on the [Ionic Forum](http://forum.ionicframework.com/).