diff --git a/CHANGELOG.md b/CHANGELOG.md index 3a2e937..9c345d4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -31,6 +31,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [0.2.0] + ### BREAKING - [#70](https://github.com/WSH032/pytauri/pull/70) - feat(notification): removed `NotificationBuilderArgs`. @@ -61,4 +63,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [0.1.0-beta] [unreleased]: https://github.com/WSH032/pytauri/tree/HEAD +[0.2.0]: https://github.com/WSH032/pytauri/releases/tag/v0.2.0 [0.1.0-beta]: https://github.com/WSH032/pytauri/releases/tag/v0.1.0-beta diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c661bac..06376d7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -156,8 +156,9 @@ please refer to `.github/workflows/docs.yml`. - Every push to the `main` branch will trigger the `dev` version docs deployment. - Every `v*` semver tag will trigger the corresponding version docs deployment. - !!! note - Remember make a Github Release (not package release) for the version docs deployment. + !!! warning + - Remember update `CHANGELOG.md` before pushing the version docs tag! + - Remember make a Github Release (not package release) manually for the version docs deployment! ## PR Checks diff --git a/README.md b/README.md index 87a9dbc..3bf6021 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,12 @@ Source Code: --- +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** diff --git a/docs/usage/concepts/ipc.md b/docs/usage/concepts/ipc.md index 4e50e11..fbe072c 100644 --- a/docs/usage/concepts/ipc.md +++ b/docs/usage/concepts/ipc.md @@ -1,8 +1,12 @@ # IPC Commands -ref: +Ref: -- [pytauri.ipc.Commands][] +- - +- [pytauri.ipc.Commands][] +- [pytauri.ipc.JavaScriptChannelId][] and [pytauri.ipc.Channel][] +- [pytauri.webview.WebviewWindow.eval][] +- [pytauri.Listener][] -TODO +TODO: details diff --git a/docs/usage/tutorial/py-js-ipc.md b/docs/usage/tutorial/py-js-ipc.md index 4cb6317..69e4473 100644 --- a/docs/usage/tutorial/py-js-ipc.md +++ b/docs/usage/tutorial/py-js-ipc.md @@ -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 to add the permission: ```json title="src-tauri/capabilities/default.json" diff --git a/docs/usage/tutorial/using-plugins.md b/docs/usage/tutorial/using-plugins.md index bad608f..5888fb6 100644 --- a/docs/usage/tutorial/using-plugins.md +++ b/docs/usage/tutorial/using-plugins.md @@ -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 to export the pyo3 bindings: ```rust title="src-tauri/src/lib.rs" @@ -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. diff --git a/docs/usage/tutorial/using-pytauri.md b/docs/usage/tutorial/using-pytauri.md index 32c3375..a0e33e5 100644 --- a/docs/usage/tutorial/using-pytauri.md +++ b/docs/usage/tutorial/using-pytauri.md @@ -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" @@ -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"