Files
vue-cli-plugin-tauri/README.md
Fabian-Lars 3cd1dae69e chore: Add deprecation warning to README.md
Let's be realisitic, that's really what happened quite some time ago so let's make it official.

Closes #83
2023-11-09 15:25:39 +01:00

57 lines
1.3 KiB
Markdown

# vue-cli-plugin-tauri
> [Tauri](https://tauri.app) is a toolkit for creating smaller, faster, and more secure desktops applications with a web frontend. This plugin configures Tauri to work in your Vue CLI project.
## Deprecation Notice
Just like [Vue CLI](https://cli.vuejs.org/) itself, this plugin is now **deprecated** and won't receive any updates anymore. Please migrate to [`@tauri-apps/cli`](https://www.npmjs.com/package/@tauri-apps/cli).
## Installation
Please visit the [documentation website](https://tauri.app) or our [discord server](https://discord.gg/tauri) if you have any problems.
### General Prerequisites:
- NodeJS/npm
- Vue CLI (`yarn global add @vue/cli` / `npm i -g @vue/cli`)
- [Rust/Cargo](https://www.rust-lang.org/)
### Detailed Prerequisite Installation Instructions:
https://tauri.app/v1/guides/getting-started/prerequisites
### Steps:
1. Create a Vue CLI project (or cd into an existing one)
```bash
vue create my-tauri-app
cd my-tauri-app
```
2. Install Vue CLI Plugin Tauri
```bash
vue add tauri
```
3. Run commands
With Yarn:
```bash
# Start dev server with HMR
yarn tauri:serve
# Build executable
yarn tauri:build
```
With npm:
```bash
# Start dev server with HMR
npm run tauri:serve
# Build executable
npm run tauri:build
```