update readmes

plugins/window-state/README.md

@@ -1,17 +1,55 @@
 ![plugin-window-state](banner.png)
 
+Save window positions and sizse and restore them when the app is reopened.
+
 <!-- description -->
 
 ## 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-window-state = { 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_window_state::Builder::default().build())
+        .run(tauri::generate_context!())
+        .expect("error while running tauri application");
+}
 ```
 
+Afterwards all windows will remember their state when the app is being closed and will restore to their previous state on the next launch.
+
+Optionally you can also tell the plugin to save the state of all open window to disk my using the `save_window_state()` method exposed by the `AppHandleExt` trait:
+```rust
+use tauri_plugin_window_state::AppHandleExt;
+
+// `tauri::AppHandle` now has the following additional method
+app.save_window_state(); // will save the state of all open windows to disk
+```
+
+To manually restore a windows state from disk you can call the `restore_state()` method exposed by the `WindowExt` trait:
+```rust
+use tauri_plugin_window_state::{WindowExt, ShowMode};
+
+// all `Window` types now have the following additional method
+window.restore_state(ShowMode::LastSaved); // will restore the windows state from disk
 ```
 
 ## Contributing
@@ -20,6 +58,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.