From e6cfc80b17f5c0fd2ee87be73201ffb7e4001d2b Mon Sep 17 00:00:00 2001 From: Jonas Kruckenberg Date: Fri, 6 Jan 2023 17:42:43 +0100 Subject: [PATCH] update readmes and package descriptions --- plugins/authenticator/Cargo.toml | 1 + plugins/authenticator/README.md | 2 +- plugins/authenticator/package.json | 1 + plugins/autostart/Cargo.toml | 1 + plugins/fs-extra/Cargo.toml | 1 + plugins/fs-extra/README.md | 4 +++- plugins/fs-extra/package.json | 1 + plugins/fs-watch/Cargo.toml | 1 + plugins/fs-watch/README.md | 2 +- plugins/fs-watch/package.json | 1 + plugins/localhost/Cargo.toml | 1 + plugins/log/Cargo.toml | 1 + plugins/log/package.json | 1 + plugins/persisted-scope/Cargo.toml | 1 + plugins/positioner/Cargo.toml | 1 + plugins/positioner/package.json | 1 + plugins/sql/Cargo.toml | 1 + plugins/sql/package.json | 1 + plugins/store/Cargo.toml | 1 + plugins/store/package.json | 1 + plugins/stronghold/Cargo.toml | 1 + plugins/stronghold/package.json | 1 + plugins/upload/Cargo.toml | 1 + plugins/upload/README.md | 2 +- plugins/upload/package.json | 1 + plugins/window-state/Cargo.toml | 1 + plugins/window-state/README.md | 2 -- 27 files changed, 28 insertions(+), 6 deletions(-) diff --git a/plugins/authenticator/Cargo.toml b/plugins/authenticator/Cargo.toml index af3d0851..145b5140 100644 --- a/plugins/authenticator/Cargo.toml +++ b/plugins/authenticator/Cargo.toml @@ -1,6 +1,7 @@ [package] name = "tauri-plugin-authenticator" version = "0.1.0" +description = "Use hardware security-keys in your Tauri App." authors.workspace = true license.workspace = true edition.workspace = true diff --git a/plugins/authenticator/README.md b/plugins/authenticator/README.md index a868a3f8..542195ae 100644 --- a/plugins/authenticator/README.md +++ b/plugins/authenticator/README.md @@ -1,6 +1,6 @@ ![plugin-authenticator](banner.png) -Use Hardware Security-keys in your Tauri App. +Use hardware security-keys in your Tauri App. ## Install diff --git a/plugins/authenticator/package.json b/plugins/authenticator/package.json index 6cf8288e..e0c7725e 100644 --- a/plugins/authenticator/package.json +++ b/plugins/authenticator/package.json @@ -1,6 +1,7 @@ { "name": "tauri-plugin-authenticator-api", "version": "0.0.0", + "description": "Use hardware security-keys in your Tauri App.", "license": "MIT or APACHE-2.0", "authors": [ "Tauri Programme within The Commons Conservancy" diff --git a/plugins/autostart/Cargo.toml b/plugins/autostart/Cargo.toml index b1a65e19..e129794e 100644 --- a/plugins/autostart/Cargo.toml +++ b/plugins/autostart/Cargo.toml @@ -1,6 +1,7 @@ [package] name = "tauri-plugin-autostart" version = "0.1.0" +description = "Automatically launch your application at startup." authors.workspace = true license.workspace = true edition.workspace = true diff --git a/plugins/fs-extra/Cargo.toml b/plugins/fs-extra/Cargo.toml index ae1c513c..79b0e7ce 100644 --- a/plugins/fs-extra/Cargo.toml +++ b/plugins/fs-extra/Cargo.toml @@ -1,6 +1,7 @@ [package] name = "tauri-plugin-fs-extra" version = "0.1.0" +description = "Additional file system methods not included in the core API." authors.workspace = true license.workspace = true edition.workspace = true diff --git a/plugins/fs-extra/README.md b/plugins/fs-extra/README.md index f2b74924..27b2756e 100644 --- a/plugins/fs-extra/README.md +++ b/plugins/fs-extra/README.md @@ -1,4 +1,6 @@ - +![tauri-plugin-fs-extra](banner.png) + +Additional file system methods not included in the core API. ## Install diff --git a/plugins/fs-extra/package.json b/plugins/fs-extra/package.json index 8929b996..52eb1eef 100644 --- a/plugins/fs-extra/package.json +++ b/plugins/fs-extra/package.json @@ -1,6 +1,7 @@ { "name": "tauri-plugin-fs-extra-api", "version": "0.0.0", + "description": "Additional file system methods not included in the core API.", "license": "MIT or APACHE-2.0", "authors": [ "Tauri Programme within The Commons Conservancy" diff --git a/plugins/fs-watch/Cargo.toml b/plugins/fs-watch/Cargo.toml index 4c943208..89501ac8 100644 --- a/plugins/fs-watch/Cargo.toml +++ b/plugins/fs-watch/Cargo.toml @@ -1,6 +1,7 @@ [package] name = "tauri-plugin-fs-watch" version = "0.1.0" +description = "Watch files and directories for changes." authors.workspace = true license.workspace = true edition.workspace = true diff --git a/plugins/fs-watch/README.md b/plugins/fs-watch/README.md index 4a0d65c0..9ce82739 100644 --- a/plugins/fs-watch/README.md +++ b/plugins/fs-watch/README.md @@ -1,6 +1,6 @@ ![plugin-fs-watch](banner.png) -Watch changes on files and directories through [notify](https://github.com/notify-rs/notify). +Watch files and directories for changes using [notify](https://github.com/notify-rs/notify). ## Install diff --git a/plugins/fs-watch/package.json b/plugins/fs-watch/package.json index c903f942..adf44a2c 100644 --- a/plugins/fs-watch/package.json +++ b/plugins/fs-watch/package.json @@ -1,6 +1,7 @@ { "name": "tauri-plugin-fs-watch-api", "version": "0.0.0", + "description": "Watch files and directories for changes.", "license": "MIT or APACHE-2.0", "authors": [ "Tauri Programme within The Commons Conservancy" diff --git a/plugins/localhost/Cargo.toml b/plugins/localhost/Cargo.toml index 416483b8..b7ccae7c 100644 --- a/plugins/localhost/Cargo.toml +++ b/plugins/localhost/Cargo.toml @@ -1,6 +1,7 @@ [package] name = "tauri-plugin-localhost" version = "0.1.0" +description = "Expose your apps assets through a localhost server instead of the default custom protocol." authors.workspace = true license.workspace = true edition.workspace = true diff --git a/plugins/log/Cargo.toml b/plugins/log/Cargo.toml index 40784b22..e590222b 100644 --- a/plugins/log/Cargo.toml +++ b/plugins/log/Cargo.toml @@ -1,6 +1,7 @@ [package] name = "tauri-plugin-log" version = "0.1.0" +description = "Configurable logging for your Tauri app." authors.workspace = true license.workspace = true edition.workspace = true diff --git a/plugins/log/package.json b/plugins/log/package.json index 9574a8fc..ff13c42d 100644 --- a/plugins/log/package.json +++ b/plugins/log/package.json @@ -1,6 +1,7 @@ { "name": "tauri-plugin-log-api", "version": "0.0.0", + "description": "Configurable logging for your Tauri app.", "license": "MIT or APACHE-2.0", "authors": [ "Tauri Programme within The Commons Conservancy" diff --git a/plugins/persisted-scope/Cargo.toml b/plugins/persisted-scope/Cargo.toml index de3c9209..7bc30228 100644 --- a/plugins/persisted-scope/Cargo.toml +++ b/plugins/persisted-scope/Cargo.toml @@ -1,6 +1,7 @@ [package] name = "tauri-plugin-persisted-scope" version = "0.1.0" +description = "Save filesystem and asset scopes and restore them when the app is reopened." authors.workspace = true license.workspace = true edition.workspace = true diff --git a/plugins/positioner/Cargo.toml b/plugins/positioner/Cargo.toml index 97f9e5bd..08155a5d 100644 --- a/plugins/positioner/Cargo.toml +++ b/plugins/positioner/Cargo.toml @@ -1,6 +1,7 @@ [package] name = "tauri-plugin-positioner" version = "0.2.7" +description = "Position your windows at well-known locations." authors.workspace = true license.workspace = true edition.workspace = true diff --git a/plugins/positioner/package.json b/plugins/positioner/package.json index 5ee70039..8f20982c 100644 --- a/plugins/positioner/package.json +++ b/plugins/positioner/package.json @@ -1,6 +1,7 @@ { "name": "tauri-plugin-positioner-api", "version": "0.0.0", + "description": "Position your windows at well-known locations.", "license": "MIT or APACHE-2.0", "authors": [ "Tauri Programme within The Commons Conservancy" diff --git a/plugins/sql/Cargo.toml b/plugins/sql/Cargo.toml index b86a945b..c72e237c 100644 --- a/plugins/sql/Cargo.toml +++ b/plugins/sql/Cargo.toml @@ -1,6 +1,7 @@ [package] name = "tauri-plugin-sql" version = "0.1.0" +description = "Interface with SQL databases." authors.workspace = true license.workspace = true edition.workspace = true diff --git a/plugins/sql/package.json b/plugins/sql/package.json index 35b279ed..9ad3d1fe 100644 --- a/plugins/sql/package.json +++ b/plugins/sql/package.json @@ -1,6 +1,7 @@ { "name": "tauri-plugin-sql-api", "version": "0.0.0", + "description": "Interface with SQL databases", "license": "MIT or APACHE-2.0", "authors": [ "Tauri Programme within The Commons Conservancy" diff --git a/plugins/store/Cargo.toml b/plugins/store/Cargo.toml index 6ef15298..9fd091fc 100644 --- a/plugins/store/Cargo.toml +++ b/plugins/store/Cargo.toml @@ -1,6 +1,7 @@ [package] name = "tauri-plugin-store" version = "0.1.0" +description = "Simple, persistent key-value store." authors.workspace = true license.workspace = true edition.workspace = true diff --git a/plugins/store/package.json b/plugins/store/package.json index cc55321f..37f6c532 100644 --- a/plugins/store/package.json +++ b/plugins/store/package.json @@ -1,6 +1,7 @@ { "name": "tauri-plugin-store-api", "version": "0.0.0", + "description": "Simple, persistent key-value store.", "license": "MIT or APACHE-2.0", "authors": [ "Tauri Programme within The Commons Conservancy" diff --git a/plugins/stronghold/Cargo.toml b/plugins/stronghold/Cargo.toml index 63835077..7abd5f07 100644 --- a/plugins/stronghold/Cargo.toml +++ b/plugins/stronghold/Cargo.toml @@ -1,6 +1,7 @@ [package] name = "tauri-plugin-stronghold" version = "0.1.0" +description = "Store secrets and keys using the IOTA Stronghold encrypted database." authors.workspace = true license.workspace = true edition.workspace = true diff --git a/plugins/stronghold/package.json b/plugins/stronghold/package.json index b929c2c2..4892e730 100644 --- a/plugins/stronghold/package.json +++ b/plugins/stronghold/package.json @@ -1,6 +1,7 @@ { "name": "tauri-plugin-stronghold-api", "version": "0.0.0", + "description": "Store secrets and keys using the IOTA Stronghold encrypted database.", "license": "MIT or APACHE-2.0", "authors": [ "Tauri Programme within The Commons Conservancy" diff --git a/plugins/upload/Cargo.toml b/plugins/upload/Cargo.toml index 2366e50f..b06c1e32 100644 --- a/plugins/upload/Cargo.toml +++ b/plugins/upload/Cargo.toml @@ -1,6 +1,7 @@ [package] name = "tauri-plugin-upload" version = "0.1.0" +description = "Upload files from disk to a remote server over HTTP." authors.workspace = true license.workspace = true edition.workspace = true diff --git a/plugins/upload/README.md b/plugins/upload/README.md index 12bddc7c..0ad80957 100644 --- a/plugins/upload/README.md +++ b/plugins/upload/README.md @@ -1,6 +1,6 @@ ![plugin-upload](banner.png) -Upload files from disk to a remote server over http. +Upload files from disk to a remote server over HTTP. ## Install diff --git a/plugins/upload/package.json b/plugins/upload/package.json index 8ec9afaf..711620b2 100644 --- a/plugins/upload/package.json +++ b/plugins/upload/package.json @@ -1,6 +1,7 @@ { "name": "tauri-plugin-upload-api", "version": "0.0.0", + "description": "Upload files from disk to a remote server over HTTP.", "license": "MIT or APACHE-2.0", "authors": [ "Tauri Programme within The Commons Conservancy" diff --git a/plugins/window-state/Cargo.toml b/plugins/window-state/Cargo.toml index 8593efcc..00d15f97 100644 --- a/plugins/window-state/Cargo.toml +++ b/plugins/window-state/Cargo.toml @@ -1,6 +1,7 @@ [package] name = "tauri-plugin-window-state" version = "0.1.0" +description = "Save window positions and sizse and restore them when the app is reopened." authors.workspace = true license.workspace = true edition.workspace = true diff --git a/plugins/window-state/README.md b/plugins/window-state/README.md index 1ef7019d..bc8094f3 100644 --- a/plugins/window-state/README.md +++ b/plugins/window-state/README.md @@ -2,8 +2,6 @@ Save window positions and sizse and restore them when the app is reopened. - - ## Install There are three general methods of installation that we can recommend.