From 0984fc8374c7d623ddc5f56cab1b235020337af2 Mon Sep 17 00:00:00 2001 From: Fabian-Lars Date: Mon, 12 Jun 2023 11:20:59 +0200 Subject: [PATCH] chore: Add branch to install instructions that use git (#433) --- plugins/authenticator/README.md | 6 +++--- plugins/autostart/README.md | 6 +++--- plugins/fs-extra/README.md | 6 +++--- plugins/fs-watch/README.md | 6 +++--- plugins/log/README.md | 6 +++--- plugins/positioner/README.md | 6 +++--- plugins/sql/README.md | 6 +++--- plugins/store/README.md | 6 +++--- plugins/stronghold/README.md | 6 +++--- plugins/upload/README.md | 6 +++--- plugins/websocket/README.md | 6 +++--- plugins/window-state/README.md | 6 +++--- shared/template/README.md | 2 ++ 13 files changed, 38 insertions(+), 36 deletions(-) diff --git a/plugins/authenticator/README.md b/plugins/authenticator/README.md index 89fa6e298..41a385109 100644 --- a/plugins/authenticator/README.md +++ b/plugins/authenticator/README.md @@ -28,11 +28,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. ```sh -pnpm add https://github.com/tauri-apps/tauri-plugin-authenticator +pnpm add https://github.com/tauri-apps/tauri-plugin-authenticator#v1 # or -npm add https://github.com/tauri-apps/tauri-plugin-authenticator +npm add https://github.com/tauri-apps/tauri-plugin-authenticator#v1 # or -yarn add https://github.com/tauri-apps/tauri-plugin-authenticator +yarn add https://github.com/tauri-apps/tauri-plugin-authenticator#v1 ``` ## Usage diff --git a/plugins/autostart/README.md b/plugins/autostart/README.md index 7c9f8ddbc..eaf79ec9b 100644 --- a/plugins/autostart/README.md +++ b/plugins/autostart/README.md @@ -26,11 +26,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. ```sh -pnpm add https://github.com/tauri-apps/tauri-plugin-autostart +pnpm add https://github.com/tauri-apps/tauri-plugin-autostart#v1 # or -npm add https://github.com/tauri-apps/tauri-plugin-autostart +npm add https://github.com/tauri-apps/tauri-plugin-autostart#v1 # or -yarn add https://github.com/tauri-apps/tauri-plugin-autostart +yarn add https://github.com/tauri-apps/tauri-plugin-autostart#v1 ``` ## Usage diff --git a/plugins/fs-extra/README.md b/plugins/fs-extra/README.md index 3eeaf003d..52f65e13f 100644 --- a/plugins/fs-extra/README.md +++ b/plugins/fs-extra/README.md @@ -26,11 +26,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. ```sh -pnpm add https://github.com/tauri-apps/tauri-plugin-fs-extra +pnpm add https://github.com/tauri-apps/tauri-plugin-fs-extra#v1 # or -npm add https://github.com/tauri-apps/tauri-plugin-fs-extra +npm add https://github.com/tauri-apps/tauri-plugin-fs-extra#v1 # or -yarn add https://github.com/tauri-apps/tauri-plugin-fs-extra +yarn add https://github.com/tauri-apps/tauri-plugin-fs-extra#v1 ``` ## Usage diff --git a/plugins/fs-watch/README.md b/plugins/fs-watch/README.md index 29f6cc114..84b651097 100644 --- a/plugins/fs-watch/README.md +++ b/plugins/fs-watch/README.md @@ -26,11 +26,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. ```sh -pnpm add https://github.com/tauri-apps/tauri-plugin-fs-watch +pnpm add https://github.com/tauri-apps/tauri-plugin-fs-watch#v1 # or -npm add https://github.com/tauri-apps/tauri-plugin-fs-watch +npm add https://github.com/tauri-apps/tauri-plugin-fs-watch#v1 # or -yarn add https://github.com/tauri-apps/tauri-plugin-fs-watch +yarn add https://github.com/tauri-apps/tauri-plugin-fs-watch#v1 ``` ## Usage diff --git a/plugins/log/README.md b/plugins/log/README.md index e4326f385..f50a7eec6 100644 --- a/plugins/log/README.md +++ b/plugins/log/README.md @@ -26,11 +26,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. ```sh -pnpm add https://github.com/tauri-apps/tauri-plugin-log +pnpm add https://github.com/tauri-apps/tauri-plugin-log#v1 # or -npm add https://github.com/tauri-apps/tauri-plugin-log +npm add https://github.com/tauri-apps/tauri-plugin-log#v1 # or -yarn add https://github.com/tauri-apps/tauri-plugin-log +yarn add https://github.com/tauri-apps/tauri-plugin-log#v1 ``` ## Usage diff --git a/plugins/positioner/README.md b/plugins/positioner/README.md index 464e3cfbb..924598e5d 100644 --- a/plugins/positioner/README.md +++ b/plugins/positioner/README.md @@ -40,11 +40,11 @@ yarn add tauri-plugin-positioner-api Or through git: ```sh -pnpm add https://github.com/tauri-apps/tauri-plugin-positioner +pnpm add https://github.com/tauri-apps/tauri-plugin-positioner#v1 # or -npm add https://github.com/tauri-apps/tauri-plugin-positioner +npm add https://github.com/tauri-apps/tauri-plugin-positioner#v1 # or -yarn add https://github.com/tauri-apps/tauri-plugin-positioner +yarn add https://github.com/tauri-apps/tauri-plugin-positioner#v1 ``` ## Usage diff --git a/plugins/sql/README.md b/plugins/sql/README.md index 2522848d5..9f2637421 100644 --- a/plugins/sql/README.md +++ b/plugins/sql/README.md @@ -28,11 +28,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. ```sh -pnpm add https://github.com/tauri-apps/tauri-plugin-sql +pnpm add https://github.com/tauri-apps/tauri-plugin-sql#v1 # or -npm add https://github.com/tauri-apps/tauri-plugin-sql +npm add https://github.com/tauri-apps/tauri-plugin-sql#v1 # or -yarn add https://github.com/tauri-apps/tauri-plugin-sql +yarn add https://github.com/tauri-apps/tauri-plugin-sql#v1 ``` ## Usage diff --git a/plugins/store/README.md b/plugins/store/README.md index 4aef4a96f..6ab5809f7 100644 --- a/plugins/store/README.md +++ b/plugins/store/README.md @@ -26,11 +26,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. ```sh -pnpm add https://github.com/tauri-apps/tauri-plugin-store +pnpm add https://github.com/tauri-apps/tauri-plugin-store#v1 # or -npm add https://github.com/tauri-apps/tauri-plugin-store +npm add https://github.com/tauri-apps/tauri-plugin-store#v1 # or -yarn add https://github.com/tauri-apps/tauri-plugin-store +yarn add https://github.com/tauri-apps/tauri-plugin-store#v1 ``` ## Usage diff --git a/plugins/stronghold/README.md b/plugins/stronghold/README.md index 5c486b966..1a1724d88 100644 --- a/plugins/stronghold/README.md +++ b/plugins/stronghold/README.md @@ -26,11 +26,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. ```sh -pnpm add https://github.com/tauri-apps/tauri-plugin-stronghold +pnpm add https://github.com/tauri-apps/tauri-plugin-stronghold#v1 # or -npm add https://github.com/tauri-apps/tauri-plugin-stronghold +npm add https://github.com/tauri-apps/tauri-plugin-stronghold#v1 # or -yarn add https://github.com/tauri-apps/tauri-plugin-stronghold +yarn add https://github.com/tauri-apps/tauri-plugin-stronghold#v1 ``` ## Usage diff --git a/plugins/upload/README.md b/plugins/upload/README.md index 48fe0153d..64e1a891b 100644 --- a/plugins/upload/README.md +++ b/plugins/upload/README.md @@ -27,11 +27,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. ```sh -pnpm add https://github.com/tauri-apps/tauri-plugin-upload +pnpm add https://github.com/tauri-apps/tauri-plugin-upload#v1 # or -npm add https://github.com/tauri-apps/tauri-plugin-upload +npm add https://github.com/tauri-apps/tauri-plugin-upload#v1 # or -yarn add https://github.com/tauri-apps/tauri-plugin-upload +yarn add https://github.com/tauri-apps/tauri-plugin-upload#v1 ``` ## Usage diff --git a/plugins/websocket/README.md b/plugins/websocket/README.md index 7c34af4ad..9ca516c50 100644 --- a/plugins/websocket/README.md +++ b/plugins/websocket/README.md @@ -26,11 +26,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. ```sh -pnpm add https://github.com/tauri-apps/tauri-plugin-websocket +pnpm add https://github.com/tauri-apps/tauri-plugin-websocket#v1 # or -npm add https://github.com/tauri-apps/tauri-plugin-websocket +npm add https://github.com/tauri-apps/tauri-plugin-websocket#v1 # or -yarn add https://github.com/tauri-apps/tauri-plugin-websocket +yarn add https://github.com/tauri-apps/tauri-plugin-websocket#v1 ``` ## Usage diff --git a/plugins/window-state/README.md b/plugins/window-state/README.md index 02a1bdd17..c0c49de66 100644 --- a/plugins/window-state/README.md +++ b/plugins/window-state/README.md @@ -26,11 +26,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. ```sh -pnpm add https://github.com/tauri-apps/tauri-plugin-window-state +pnpm add https://github.com/tauri-apps/tauri-plugin-window-state#v1 # or -npm add https://github.com/tauri-apps/tauri-plugin-window-state +npm add https://github.com/tauri-apps/tauri-plugin-window-state#v1 # or -yarn add https://github.com/tauri-apps/tauri-plugin-window-state +yarn add https://github.com/tauri-apps/tauri-plugin-window-state#v1 ``` ## Usage diff --git a/shared/template/README.md b/shared/template/README.md index 413618b97..56a9c27d5 100644 --- a/shared/template/README.md +++ b/shared/template/README.md @@ -25,6 +25,8 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. + + ```sh pnpm add # or