tauri-apps/tauri
1
1
Fork 0
mirror of https://github.com/tauri-apps/tauri.git synced 2024-12-28 21:45:00 +03:00
Code Issues Packages Projects Releases Wiki Activity

mark the runtime crates as unstable API

Browse Source
This commit is contained in:
Chip Reed 2024-07-25 17:42:48 +09:00
parent 22b5c32553
commit 9284897644
No known key found for this signature in database
4 changed files with 38 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
core/tauri-runtime-wry/README.md
View File

@ -12,20 +12,30 @@
[![support](https://img.shields.io/badge/sponsor-Opencollective-blue.svg)](https://opencollective.com/tauri)
| Component | Version |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------- |
|-------------------|------------------------------------------------------------------------------------------------------------------------|
| tauri-runtime-wry | [![](https://img.shields.io/crates/v/tauri-runtime-wry?style=flat-square)](https://crates.io/crates/tauri-runtime-wry) |
## About Tauri
Tauri is a polyglot and generic system that is very composable and allows engineers to make a wide variety of applications. It is used for building applications for Desktop Computers using a combination of Rust tools and HTML rendered in a Webview. Apps built with Tauri can ship with any number of pieces of an optional JS API / Rust API so that webviews can control the system via message passing. In fact, developers can extend the default API with their own functionality and bridge the Webview and Rust-based backend easily.
Tauri is a polyglot and generic system that is very composable and allows engineers to make a wide variety of
applications. It is used for building applications for Desktop Computers using a combination of Rust tools and HTML
rendered in a Webview. Apps built with Tauri can ship with any number of pieces of an optional JS API / Rust API so that
webviews can control the system via message passing. In fact, developers can extend the default API with their own
functionality and bridge the Webview and Rust-based backend easily.
Tauri apps can have custom menus and have tray-type interfaces. They can be updated, and are managed by the user's operating system as expected. They are very small, because they use the system's webview. They do not ship a runtime, since the final binary is compiled from rust. This makes the reversing of Tauri apps not a trivial task.
Tauri apps can have custom menus and have tray-type interfaces. They can be updated, and are managed by the user's
operating system as expected. They are very small, because they use the system's webview. They do not ship a runtime,
since the final binary is compiled from rust. This makes the reversing of Tauri apps not a trivial task.
## This module
This crate opens up direct systems-level interactions specifically for WRY, such as printing, monitor detection, and other windowing related tasks. `tauri-runtime` implementation for WRY.
This crate opens up direct systems-level interactions specifically for WRY, such as printing, monitor detection, and
other windowing related tasks. `tauri-runtime` implementation for WRY.
None of the exposed API of this crate is stable, and it may break semver
compatibility in the future. The major version only signifies the intended Tauri version.
To learn more about the details of how all of these pieces fit together, please consult this [ARCHITECTURE.md](https://github.com/tauri-apps/tauri/blob/dev/ARCHITECTURE.md) document.
To learn more about the details of how all of these pieces fit together, please consult
this [ARCHITECTURE.md](https://github.com/tauri-apps/tauri/blob/dev/ARCHITECTURE.md) document.
## Semver
@ -39,4 +49,5 @@ MIT or MIT/Apache 2.0 where applicable.
Logo: CC-BY-NC-ND
- Original Tauri Logo Designs by [Daniel Thompson-Yvetot](https://github.com/nothingismagick) and [Guillaume Chau](https://github.com/akryum)
- Original Tauri Logo Designs by [Daniel Thompson-Yvetot](https://github.com/nothingismagick)
and [Guillaume Chau](https://github.com/akryum)

3
core/tauri-runtime-wry/src/lib.rs
View File

@ -5,6 +5,9 @@
//! [![](https://github.com/tauri-apps/tauri/raw/dev/.github/splash.png)](https://tauri.app)
//!
//! The [`wry`] Tauri [`Runtime`].
//!
//! None of the exposed API of this crate is stable, and it may break semver compatibility in the
//! future. The major version only signifies the intended Tauri version.
#![doc(
html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png",

20
core/tauri-runtime/README.md
View File

@ -12,20 +12,29 @@
[![support](https://img.shields.io/badge/sponsor-Opencollective-blue.svg)](https://opencollective.com/tauri)
| Component | Version |
| ------------- | -------------------------------------------------------------------------------------------------------------- |
|---------------|----------------------------------------------------------------------------------------------------------------|
| tauri-runtime | [![](https://img.shields.io/crates/v/tauri-runtime?style=flat-square)](https://crates.io/crates/tauri-runtime) |
## About Tauri
Tauri is a polyglot and generic system that is very composable and allows engineers to make a wide variety of applications. It is used for building applications for Desktop Computers using a combination of Rust tools and HTML rendered in a Webview. Apps built with Tauri can ship with any number of pieces of an optional JS API / Rust API so that webviews can control the system via message passing. In fact, developers can extend the default API with their own functionality and bridge the Webview and Rust-based backend easily.
Tauri is a polyglot and generic system that is very composable and allows engineers to make a wide variety of
applications. It is used for building applications for Desktop Computers using a combination of Rust tools and HTML
rendered in a Webview. Apps built with Tauri can ship with any number of pieces of an optional JS API / Rust API so that
webviews can control the system via message passing. In fact, developers can extend the default API with their own
functionality and bridge the Webview and Rust-based backend easily.
Tauri apps can have custom menus and have tray-type interfaces. They can be updated, and are managed by the user's operating system as expected. They are very small, because they use the system's webview. They do not ship a runtime, since the final binary is compiled from rust. This makes the reversing of Tauri apps not a trivial task.
Tauri apps can have custom menus and have tray-type interfaces. They can be updated, and are managed by the user's
operating system as expected. They are very small, because they use the system's webview. They do not ship a runtime,
since the final binary is compiled from rust. This makes the reversing of Tauri apps not a trivial task.
## This module
This is the glue layer between tauri itself and lower level webview libraries.
None of the exposed API of this crate is stable, and it may break semver
compatibility in the future. The major version only signifies the intended Tauri version.
To learn more about the details of how all of these pieces fit together, please consult this [ARCHITECTURE.md](https://github.com/tauri-apps/tauri/blob/dev/ARCHITECTURE.md) document.
To learn more about the details of how all of these pieces fit together, please consult
this [ARCHITECTURE.md](https://github.com/tauri-apps/tauri/blob/dev/ARCHITECTURE.md) document.
## Semver
@ -39,4 +48,5 @@ MIT or MIT/Apache 2.0 where applicable.
Logo: CC-BY-NC-ND
- Original Tauri Logo Designs by [Daniel Thompson-Yvetot](https://github.com/nothingismagick) and [Guillaume Chau](https://github.com/akryum)
- Original Tauri Logo Designs by [Daniel Thompson-Yvetot](https://github.com/nothingismagick)
and [Guillaume Chau](https://github.com/akryum)

3
core/tauri-runtime/src/lib.rs
View File

@ -5,6 +5,9 @@
//! [![](https://github.com/tauri-apps/tauri/raw/dev/.github/splash.png)](https://tauri.app)
//!
//! Internal runtime between Tauri and the underlying webview runtime.
//!
//! None of the exposed API of this crate is stable, and it may break semver compatibility in the
//! future. The major version only signifies the intended Tauri version.
#![doc(
html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png",