Skip to content
This repository was archived by the owner on May 12, 2025. It is now read-only.

Commit 90e2aae

Browse files
committed
chore: readme tweak
1 parent 6e7603e commit 90e2aae

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

packages/tauri/README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,37 @@
11
<p align="center">
2-
<img src="https://user-images.githubusercontent.com/20338451/128799226-dc84c780-a031-4899-9880-3c9df4c2c52b.png" width="835" height="168" /><br />
2+
<img src="https://user-images.githubusercontent.com/20338451/128799226-dc84c780-a031-4899-9880-3c9df4c2c52b.png" width="560" /><br />
33
</p>
44

55
<p align="center">
66
Bring your Capacitor ⚡ apps to the desktop with Tauri! 🖥
77
</p>
88
<p align="center">
9-
<a href="https://github.com/capacitor-community/tauri"><img src="https://img.shields.io/badge/maintenance%20status-actively%20maintained-brightgreen" /></a>
9+
<a href="https://github.com/capacitor-community/tauri"><img src="https://img.shields.io/badge/maintenance%20status-being%20developed-orange" /></a>
1010
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
1111
<a href="#contributors"><img src="https://img.shields.io/badge/all%20contributors-9-orange" /></a>
1212
<!-- ALL-CONTRIBUTORS-BADGE:END -->
1313
<a href="https://www.electronjs.org/releases/stable?version=13"><img src="https://img.shields.io/badge/tauri%20version-v1.0.0--beta.5-blue" /></a>
1414
</p>
1515
<p align="center">
16-
<a href="https://npmjs.com/package/@capacitor-community/tauri"><img src="https://img.shields.io/npm/v/@capacitor-community/tauri/next.svg" /></a>
16+
<a href="https://npmjs.com/package/@capacitor-community/tauri"><img src="https://img.shields.io/npm/v/@capacitor-community/tauri" /></a>
1717
<a href="https://npmjs.com/package/@capacitor-community/tauri"><img alt="npm" src="https://img.shields.io/npm/dw/@capacitor-community/tauri"></a>
1818
<a href="https://npmjs.com/package/@capacitor-community/tauri"><img src="https://img.shields.io/npm/l/@capacitor-community/tauri.svg?color=blue" /></a>
19-
<a href="https://github.com/capacitor-community/tauri"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/capacitor-community/tauri/CI/next"></a>
19+
<a href="https://github.com/capacitor-community/tauri"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/capacitor-community/tauri/CI"></a>
2020
</p>
2121

2222
## ⚠ Important Info
2323
- Please follow your operating systems guide to setup your environment for Tauri development [here](https://tauri.studio/en/docs/getting-started/intro#setting-up-your-environment)
2424
- You will need a local build of `@capacitor/core` via `npm link` using this [PR](https://github.com/ionic-team/capacitor/pull/4771) until the PR is merged and published in a release.
2525

26+
## ⏳ Quickstart (super bare bones for now as the platform is just in alpha)
27+
0. Create or open a Capacitor initialized web app project. [CAPACITOR DOCS](https://capacitorjs.com/docs)
28+
1. `npm i @capacitor-community/tauri`
29+
2. `npx cap add @capacitor-community/tauri`
30+
3. Edit `APP_ROOT/tauri/src-tauri/tauri.conf.json -> build.devPath` to contain the url of you web app when running in dev mode. For example react app runs on `http://localhost:3000`.
31+
4. Make sure your web app is running. For example, `npm run start` from the `APP_ROOT`
32+
5. `npx cap open @capacitor-community/tauri`
33+
6. You now have your web app running in tauri, right click and select `inspect` to bring up dev tools.
34+
2635
## 🛠 Maintainers
2736

2837
| Maintainer | GitHub | Social | Sponsoring Company | Primary |

0 commit comments

Comments
 (0)