diff --git a/README.md b/README.md index 5334cc3d..f18cc6e0 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,47 @@

- - Yes, the image needs to be updated :) +

-

NativeScript-Vue3 RC

+

NativeScript-Vue3

- npm + npm - license + license

-NativeScript-Vue with Vue3 support now in RC! +NativeScript-Vue now supports Vue 3 and is generally available! This version brings improved reactivity, a modern plugin system, and better TypeScript support. -## Quick start +## Quick Start -To get started, you can use the [StackBlitz Template](https://stackblitz.com/fork/github/nativescript-vue/nativescript-vue/tree/main/packages/stackblitz-template?file=src%2Fcomponents%2FHome.vue&title=NativeScript%20Starter%20Vue3) +To get started, you can use the [StackBlitz Template](https://stackblitz.com/fork/github/nativescript-vue/nativescript-vue/tree/main/packages/stackblitz-template?file=src%2Fcomponents%2FHome.vue&title=NativeScript%20Starter%20Vue3). -...or locally: +Or, set up locally: -```bash -ns create myAwesomeApp --template @nativescript-vue/template-blank@rc +```sh +ns create myAwesomeApp --template @nativescript-vue/template-blank@latest cd myAwesomeApp ns run ios|android ``` -## Vue Devtools +## Upgrading to v3 -To use VueDevtools, run: +Please refer to our [Upgrade Guide](https://nativescript-vue.org/docs/essentials/upgrade-guide). -```bash +## Using Vue Devtools + +To enable Vue Devtools, run: + +```sh ns run ios|android --env.vueDevtools ``` -This will launch the standalone VueDevtools, and connect to it once the app launches. Right now, devtools are only supported on iOS Simulators and Android Emulators, but physical device support should come soon (requires configuring a host/port that the device can connect to.). - -On android, you must enable cleartext http traffic, otherwise any connections are silently dropped by the system. In the `App_Resources/Android/src/main/AndroidManifext.xml` add the following to your existing `` tag: +🛠️ **Android Users:** +To allow Vue Devtools to connect, enable **cleartext HTTP traffic** in your `AndroidManifest.xml`: ```diff