chore: document supported platforms on README, clarify unsupported APIs

closes #1795
tauri-apps · Oct 1, 2024 · 2188a8c · 2188a8c
1 parent 3b2bd30
commit 2188a8c
Show file tree

Hide file tree

Showing 38 changed files with 265 additions and 23 deletions.
diff --git a/examples/api/vite.config.js b/examples/api/vite.config.js
@@ -26,13 +26,6 @@ export default defineConfig(async () => {
       host: host || false,
       port: 5173,
       strictPort: true,
-      hmr: host
-        ? {
-            protocol: 'ws',
-            host,
-            port: 5183
-          }
-        : undefined,
       fs: {
         allow: ['.', '../../tooling/api/dist']
       }

diff --git a/plugins/autostart/README.md b/plugins/autostart/README.md
@@ -1,6 +1,14 @@
 ![plugin-autostart](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/autostart/banner.png)
 
-Automatically launch your application at startup. Supports Windows, Mac (via AppleScript or Launch Agent), and Linux.
+Automatically launch your application at startup.
+
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | ✓         |
+| Windows  | ✓         |
+| macOS    | ✓         |
+| Android  | x         |
+| iOS      | x         |
 
 ## Install
 

diff --git a/plugins/barcode-scanner/README.md b/plugins/barcode-scanner/README.md
@@ -2,6 +2,14 @@
 
 Allows your mobile application to use the camera to scan QR codes, EAN-13 and other kinds of barcodes.
 
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | x         |
+| Windows  | x         |
+| macOS    | x         |
+| Android  | ✓         |
+| iOS      | ✓         |
+
 ## Install
 
 _This plugin requires a Rust version of at least **1.64**_

diff --git a/plugins/biometric/README.md b/plugins/biometric/README.md
@@ -2,6 +2,14 @@
 
 Prompt the user for biometric authentication on Android and iOS.
 
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | x         |
+| Windows  | x         |
+| macOS    | x         |
+| Android  | ✓         |
+| iOS      | ✓         |
+
 ## Install
 
 _This plugin requires a Rust version of at least **1.65**_

diff --git a/plugins/cli/README.md b/plugins/cli/README.md
@@ -2,7 +2,13 @@
 
 Parse arguments from your Command Line Interface.
 
-- Supported platforms: Windows, Linux and macOS.
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | ✓         |
+| Windows  | ✓         |
+| macOS    | ✓         |
+| Android  | x         |
+| iOS      | x         |
 
 ## Install
 

diff --git a/plugins/clipboard-manager/README.md b/plugins/clipboard-manager/README.md
@@ -2,6 +2,14 @@
 
 Read and write to the system clipboard.
 
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | ✓         |
+| Windows  | ✓         |
+| macOS    | ✓         |
+| Android  | ✓         |
+| iOS      | ✓         |
+
 ## Install
 
 _This plugin requires a Rust version of at least **1.75**_

diff --git a/plugins/clipboard-manager/guest-js/index.ts b/plugins/clipboard-manager/guest-js/index.ts
@@ -49,6 +49,11 @@ async function readText(): Promise<string> {
 
 /**
  * Writes image buffer to the clipboard.
+ *
+ * #### Platform-specific
+ *
+ * - **Android / iOS:** Not supported.
+ *
  * @example
  * ```typescript
  * import { writeImage } from '@tauri-apps/plugin-clipboard-manager';
@@ -75,6 +80,11 @@ async function writeImage(
 
 /**
  * Gets the clipboard content as Uint8Array image.
+ *
+ * #### Platform-specific
+ *
+ * - **Android / iOS:** Not supported.
+ *
  * @example
  * ```typescript
  * import { readImage } from '@tauri-apps/plugin-clipboard-manager';
@@ -93,6 +103,11 @@ async function readImage(): Promise<Image> {
 
 /**
  * * Writes HTML or fallbacks to write provided plain text to the clipboard.
+ *
+ * #### Platform-specific
+ *
+ * - **Android / iOS:** Not supported.
+ *
  * @example
  * ```typescript
  * import { writeHtml, readHtml } from '@tauri-apps/plugin-clipboard-manager';

diff --git a/plugins/deep-link/README.md b/plugins/deep-link/README.md
@@ -2,6 +2,14 @@
 
 Set your Tauri application as the default handler for an URL.
 
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | ✓         |
+| Windows  | ✓         |
+| macOS    | ✓         |
+| Android  | ✓         |
+| iOS      | ✓         |
+
 ## Install
 
 _This plugin requires a Rust version of at least **1.75**_

diff --git a/plugins/dialog/README.md b/plugins/dialog/README.md
@@ -2,6 +2,14 @@
 
 Native system dialogs for opening and saving files along with message dialogs.
 
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | ✓         |
+| Windows  | ✓         |
+| macOS    | ✓         |
+| Android  | ✓         |
+| iOS      | ✓         |
+
 ## Install
 
 _This plugin requires a Rust version of at least **1.75**_

diff --git a/plugins/fs/README.md b/plugins/fs/README.md
@@ -2,6 +2,14 @@
 
 Access the file system.
 
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | ✓         |
+| Windows  | ✓         |
+| macOS    | ✓         |
+| Android  | ✓         |
+| iOS      | ✓         |
+
 ## Install
 
 _This plugin requires a Rust version of at least **1.75**_

diff --git a/plugins/geolocation/README.md b/plugins/geolocation/README.md
@@ -2,6 +2,14 @@
 
 This plugin provides APIs for getting and tracking the device's current position, including information about altitude, heading, and speed (if available).
 
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | x         |
+| Windows  | x         |
+| macOS    | x         |
+| Android  | ✓         |
+| iOS      | ✓         |
+
 ## Install
 
 _This plugin requires a Rust version of at least **1.75**_

diff --git a/plugins/global-shortcut/README.md b/plugins/global-shortcut/README.md
@@ -2,7 +2,13 @@
 
 Register global shortcuts.
 
-- Supported platforms: Windows, Linux and macOS.
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | ✓         |
+| Windows  | ✓         |
+| macOS    | ✓         |
+| Android  | x         |
+| iOS      | x         |
 
 ## Install
 

diff --git a/plugins/haptics/README.md b/plugins/haptics/README.md
@@ -4,6 +4,14 @@ Haptic feedback and vibrations on Android and iOS.
 
 There are no standards/requirements for vibration support on Android, so the `feedback` APIs may not work correctly on more affordable phones, including recently released ones.
 
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | x         |
+| Windows  | x         |
+| macOS    | x         |
+| Android  | ✓         |
+| iOS      | ✓         |
+
 ## Install
 
 _This plugin requires a Rust version of at least **1.75**_

diff --git a/plugins/http/README.md b/plugins/http/README.md
@@ -2,6 +2,14 @@
 
 Access the HTTP client written in Rust.
 
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | ✓         |
+| Windows  | ✓         |
+| macOS    | ✓         |
+| Android  | ✓         |
+| iOS      | ✓         |
+
 ## Install
 
 _This plugin requires a Rust version of at least **1.75**_

diff --git a/plugins/localhost/README.md b/plugins/localhost/README.md
@@ -2,6 +2,14 @@
 
 Expose your apps assets through a localhost server instead of the default custom protocol.
 
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | ✓         |
+| Windows  | ✓         |
+| macOS    | ✓         |
+| Android  | ✓         |
+| iOS      | ✓         |
+
 > Note: This plugins brings considerable security risks and you should only use it if you know what your are doing. If in doubt, use the default custom protocol implementation.
 
 ## Install

diff --git a/plugins/log/README.md b/plugins/log/README.md
@@ -2,6 +2,14 @@
 
 Configurable logging for your Tauri app.
 
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | ✓         |
+| Windows  | ✓         |
+| macOS    | ✓         |
+| Android  | ✓         |
+| iOS      | ✓         |
+
 ## Install
 
 _This plugin requires a Rust version of at least **1.75**_

diff --git a/plugins/nfc/README.md b/plugins/nfc/README.md
@@ -2,6 +2,14 @@
 
 Read and write NFC tags on Android and iOS.
 
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | x         |
+| Windows  | x         |
+| macOS    | x         |
+| Android  | ✓         |
+| iOS      | ✓         |
+
 ## Install
 
 _This plugin requires a Rust version of at least **1.65**_

diff --git a/plugins/notification/README.md b/plugins/notification/README.md
@@ -2,6 +2,14 @@
 
 Send message notifications (brief auto-expiring OS window element) to your user. Can also be used with the Notification Web API.
 
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | ✓         |
+| Windows  | ✓         |
+| macOS    | ✓         |
+| Android  | ✓         |
+| iOS      | ✓         |
+
 ## Install
 
 _This plugin requires a Rust version of at least **1.75**_

diff --git a/plugins/os/README.md b/plugins/os/README.md
@@ -2,6 +2,14 @@
 
 Read information about the operating system.
 
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | ✓         |
+| Windows  | ✓         |
+| macOS    | ✓         |
+| Android  | ✓         |
+| iOS      | ✓         |
+
 ## Install
 
 _This plugin requires a Rust version of at least **1.75**_

diff --git a/plugins/persisted-scope/Cargo.toml b/plugins/persisted-scope/Cargo.toml
@@ -16,8 +16,8 @@ rustdoc-args = ["--cfg", "docsrs"]
 windows = { level = "full", notes = "" }
 linux = { level = "full", notes = "" }
 macos = { level = "full", notes = "" }
-android = { level = "none", notes = "" }
-ios = { level = "none", notes = "" }
+android = { level = "full", notes = "" }
+ios = { level = "full", notes = "" }
 
 [dependencies]
 serde = { workspace = true }

diff --git a/plugins/persisted-scope/README.md b/plugins/persisted-scope/README.md
@@ -2,6 +2,14 @@
 
 Save filesystem and asset scopes and restore them when the app is reopened.
 
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | ✓         |
+| Windows  | ✓         |
+| macOS    | ✓         |
+| Android  | ✓         |
+| iOS      | ✓         |
+
 ## Install
 
 _This plugin requires a Rust version of at least **1.75**_

diff --git a/plugins/positioner/README.md b/plugins/positioner/README.md
@@ -4,6 +4,14 @@ Position your windows at well-known locations.
 
 This plugin is a port of [electron-positioner](https://github.com/jenslind/electron-positioner) for Tauri.
 
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | ✓         |
+| Windows  | ✓         |
+| macOS    | ✓         |
+| Android  | x         |
+| iOS      | x         |
+
 ## Install
 
 _This plugin requires a Rust version of at least **1.75**_

diff --git a/plugins/process/README.md b/plugins/process/README.md
@@ -2,6 +2,14 @@
 
 This plugin provides APIs to access the current process. To spawn child processes, see the [`shell`](https://github.com/tauri-apps/tauri-plugin-shell) plugin.
 
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | ✓         |
+| Windows  | ✓         |
+| macOS    | ✓         |
+| Android  | x         |
+| iOS      | x         |
+
 ## Install
 
 _This plugin requires a Rust version of at least **1.75**_

diff --git a/plugins/shell/README.md b/plugins/shell/README.md
@@ -2,6 +2,14 @@
 
 Access the system shell. Allows you to spawn child processes and manage files and URLs using their default application.
 
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | ✓         |
+| Windows  | ✓         |
+| macOS    | ✓         |
+| Android  | ✓         |
+| iOS      | ✓         |
+
 ## Install
 
 _This plugin requires a Rust version of at least **1.75**_

diff --git a/plugins/single-instance/README.md b/plugins/single-instance/README.md
@@ -2,6 +2,14 @@
 
 Ensure a single instance of your tauri app is running.
 
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | ✓         |
+| Windows  | ✓         |
+| macOS    | ✓         |
+| Android  | x         |
+| iOS      | x         |
+
 ## Install
 
 _This plugin requires a Rust version of at least **1.75**_