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

Commit 05055f1

Browse files
committed
chore: add quickstart to readme
1 parent 2b238ba commit 05055f1

File tree

2 files changed

+38
-2
lines changed

2 files changed

+38
-2
lines changed

.all-contributorsrc

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"projectName": "tauri",
3+
"projectOwner": "capacitor-community",
4+
"repoType": "github",
5+
"badgeTemplate": "<a href=\"#contributors\"><img src=\"https://img.shields.io/badge/all%20contributors-<%= contributors.length %>-orange?style=flat-square\" /></a>",
6+
"repoHost": "https://github.com",
7+
"files": [
8+
"README.md"
9+
],
10+
"imageSize": 75,
11+
"commit": true,
12+
"commitConvention": "none",
13+
"contributors": [
14+
{
15+
"login": "IT-MikeS",
16+
"name": "Mike S",
17+
"avatar_url": "https://avatars0.githubusercontent.com/u/20338451?v=4",
18+
"profile": "https://github.com/IT-MikeS",
19+
"contributions": [
20+
"code",
21+
"doc"
22+
]
23+
}
24+
],
25+
"contributorsPerLine": 7,
26+
"skipCi": true
27+
}

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
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>
1919
<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>
@@ -23,6 +23,15 @@ Bring your Capacitor ⚡ apps to the desktop with Tauri! 🖥
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)