update readmes

This commit is contained in:
Jonas Kruckenberg
2023-01-06 14:21:57 +01:00
parent 2eb8d7e636
commit 08f90f0fb4
15 changed files with 702 additions and 35 deletions
+24 -4
View File
@@ -1,18 +1,38 @@
![plugin-persisted-scope](banner.png)
<!-- description -->
Save filesystem and asset scopes and restore them when the app is reopened.
## Install
```
There are three general methods of installation that we can recommend.
1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
2. Pull sources directly from Github using git tags / revision hashes (most secure)
3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)
Install the Core plugin by adding the following to your `Cargo.toml` file:
`src-tauri/Cargo.toml`
```toml
[dependencies]
tauri-plugin-persisted-scope = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" }
```
## Usage
First you need to register the core plugin with Tauri:
`src-tauri/src/main.rs`
```rust
fn main() {
tauri::Builder::default()
.plugin(tauri_plugin_persisted_scope::init())
.run(tauri::generate_context!())
.expect("error while running tauri application");
}
```
```
Afterwards the plugin will automatically save and restore filesystem and asset scopes.
## Contributing
@@ -20,6 +40,6 @@ PRs accepted. Please make sure to read the Contributing Guide before making a pu
## License
Code: (c) 2015 - 2021 - The Tauri Programme within The Commons Conservancy.
Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.
MIT or MIT/Apache 2.0 where applicable.