Skip to content

Commit

Permalink
chore: add quickstart to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
IT-MikeS committed Aug 10, 2021
1 parent 2b238ba commit 05055f1
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 2 deletions.
27 changes: 27 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"projectName": "tauri",
"projectOwner": "capacitor-community",
"repoType": "github",
"badgeTemplate": "<a href=\"#contributors\"><img src=\"https://img.shields.io/badge/all%20contributors-<%= contributors.length %>-orange?style=flat-square\" /></a>",
"repoHost": "https://github.com",
"files": [
"README.md"
],
"imageSize": 75,
"commit": true,
"commitConvention": "none",
"contributors": [
{
"login": "IT-MikeS",
"name": "Mike S",
"avatar_url": "https://avatars0.githubusercontent.com/u/20338451?v=4",
"profile": "https://github.com/IT-MikeS",
"contributions": [
"code",
"doc"
]
}
],
"contributorsPerLine": 7,
"skipCi": true
}
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
Bring your Capacitor ⚡ apps to the desktop with Tauri! 🖥
</p>
<p align="center">
<a href="https://github.com/capacitor-community/tauri"><img src="https://img.shields.io/badge/maintenance%20status-actively%20maintained-brightgreen" /></a>
<a href="https://github.com/capacitor-community/tauri"><img src="https://img.shields.io/badge/maintenance%20status-being%20developed-orange" /></a>
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<a href="#contributors"><img src="https://img.shields.io/badge/all%20contributors-9-orange" /></a>
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<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>
</p>
<p align="center">
<a href="https://npmjs.com/package/@capacitor-community/tauri"><img src="https://img.shields.io/npm/v/@capacitor-community/tauri/next.svg" /></a>
<a href="https://npmjs.com/package/@capacitor-community/tauri"><img src="https://img.shields.io/npm/v/@capacitor-community/tauri" /></a>
<a href="https://npmjs.com/package/@capacitor-community/tauri"><img alt="npm" src="https://img.shields.io/npm/dw/@capacitor-community/tauri"></a>
<a href="https://npmjs.com/package/@capacitor-community/tauri"><img src="https://img.shields.io/npm/l/@capacitor-community/tauri.svg?color=blue" /></a>
<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>
Expand All @@ -23,6 +23,15 @@ Bring your Capacitor ⚡ apps to the desktop with Tauri! 🖥
- 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)
- 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.

## ⏳ Quickstart (super bare bones for now as the platform is just in alpha)
0. Create or open a Capacitor initialized web app project. [CAPACITOR DOCS](https://capacitorjs.com/docs)
1. `npm i @capacitor-community/tauri`
2. `npx cap add @capacitor-community/tauri`
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`.
4. Make sure your web app is running. For example, `npm run start` from the `APP_ROOT`
5. `npx cap open @capacitor-community/tauri`
6. You now have your web app running in tauri, right click and select `inspect` to bring up dev tools.

## 🛠 Maintainers

| Maintainer | GitHub | Social | Sponsoring Company | Primary |
Expand Down

0 comments on commit 05055f1

Please sign in to comment.