Skip to content

Commit

Permalink
docs: update docs for v0.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
WSH032 committed Feb 5, 2025
1 parent 776369b commit 0b7a893
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 8 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ Source Code: <https://github.com/WSH032/pytauri/>

---

This is a completely free and open-source project, but it is difficult to maintain without incentives and contributions from the community.

If you think this project is helpful, consider giving it a star ![GitHub Repo stars](https://img.shields.io/github/stars/wsh032/pytauri?style=social), it would be very helpful for my work and studies. 🥺👉👈

---

## Features

> **TL;DR**
Expand Down
10 changes: 7 additions & 3 deletions docs/usage/concepts/ipc.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# IPC Commands

ref:
Ref:

- [pytauri.ipc.Commands][]
- <https://tauri.app/develop/calling-frontend/>
- <https://tauri.app/develop/calling-rust/>
- [pytauri.ipc.Commands][]
- [pytauri.ipc.JavaScriptChannelId][] and [pytauri.ipc.Channel][]
- [pytauri.webview.WebviewWindow.eval][]
- [pytauri.Listener][]

TODO
TODO: details
4 changes: 3 additions & 1 deletion docs/usage/tutorial/py-js-ipc.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@ You need to add it to the dependencies so that you can enable its permission in

[dependencies]
# ...
tauri-plugin-pytauri = { version = "0.1.0-beta.0" }
tauri-plugin-pytauri = { version = "0.2" } # (1)!
```

1. This is the version at the time of writing this tutorial. There may be a newer version of pytauri available when you use it.

Refer to <https://tauri.app/security/capabilities/> to add the permission:

```json title="src-tauri/capabilities/default.json"
Expand Down
8 changes: 6 additions & 2 deletions docs/usage/tutorial/using-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,12 @@ Add the rust dependency:

```bash
cd src-tauri
cargo add pytauri-plugin-notification@0.1.0-beta.0
cargo add pytauri-plugin-notification@0.2 # (1)!
cd ..
```

1. This is the version at the time of writing this tutorial. There may be a newer version of pytauri available when you use it.

ref to <https://pyo3.rs/v0.23.3/module.html> to export the pyo3 bindings:

```rust title="src-tauri/src/lib.rs"
Expand Down Expand Up @@ -65,10 +67,12 @@ Add the python dependency:
# ...
dependencies = [
# ...
"pytauri-plugin-notification == 0.1.*",
"pytauri-plugin-notification == 0.2.*", # (1)!
]
```

1. This is the version at the time of writing this tutorial. There may be a newer version of pytauri available when you use it.

!!! tip
After adding dependencies, you need to use commands like `uv sync` or `uv pip install` to synchronize your dependency environment.

Expand Down
6 changes: 4 additions & 2 deletions docs/usage/tutorial/using-pytauri.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ name = "tauri-app" # (1)!
version = "0.1.0"
description = "Add your description here"
requires-python = ">=3.9"
dependencies = ["pytauri == 0.1.*"] # (2)!
dependencies = ["pytauri == 0.2.*"] # (2)!

[project.entry-points.pytauri]
ext_mod = "tauri_app.ext_mod"
Expand Down Expand Up @@ -110,9 +110,11 @@ required-features = ["pytauri/standalone"]
[dependencies]
# ...
pyo3 = { version = "0.23" }
pytauri = { version = "0.1.0-beta.0" }
pytauri = { version = "0.2" } # (1)!
```

1. This is the version at the time of writing this tutorial. There may be a newer version of pytauri available when you use it.

Also, enable the `pytauri/standalone` feature:

```json title="src-tauri/tauri.conf.json"
Expand Down

0 comments on commit 0b7a893

Please sign in to comment.