snapshot of https://github.com/tauri-apps/plugins-workspace.git (v2, 2026-09-23; blobs > 131072B omitted)

plugins/upload/README.md

@@ -0,0 +1,121 @@
+![plugin-upload](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/upload/banner.png)
+
+Upload files from disk to a remote server over HTTP.
+Download files from a remote HTTP server to disk.
+
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | ✓         |
+| Windows  | ✓         |
+| macOS    | ✓         |
+| Android  | ✓         |
+| iOS      | ✓         |
+
+## Install
+
+_This plugin requires a Rust version of at least **1.77.2**_
+
+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-upload = "2.0.0"
+# alternatively with Git:
+tauri-plugin-upload = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" }
+```
+
+You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
+
+```sh
+pnpm add @tauri-apps/plugin-upload
+# or
+npm add @tauri-apps/plugin-upload
+# or
+yarn add @tauri-apps/plugin-upload
+```
+
+## Usage
+
+First you need to register the core plugin with Tauri:
+
+`src-tauri/src/lib.rs`
+
+```rust
+fn main() {
+    tauri::Builder::default()
+        .plugin(tauri_plugin_upload::init())
+        .run(tauri::generate_context!())
+        .expect("error while running tauri application");
+}
+```
+
+Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
+
+```javascript
+import { upload, HttpMethod } from '@tauri-apps/plugin-upload'
+
+// Upload with default POST method
+upload(
+  'https://example.com/file-upload',
+  './path/to/my/file.txt',
+  ({ progressTotal, total }) =>
+    console.log(`Uploaded ${progressTotal} of ${total} bytes`), // a callback that will be called with the upload progress
+  { 'Content-Type': 'text/plain' } // optional headers to send with the request
+)
+
+// Upload with specific HTTP method
+upload(
+  'https://example.com/file-upload',
+  './path/to/my/file.txt',
+  ({ progressTotal, total }) =>
+    console.log(`Uploaded ${progressTotal} of ${total} bytes`),
+  { 'Content-Type': 'text/plain' },
+  HttpMethod.Put // Use HttpMethod enum - supports POST, PUT, PATCH
+)
+```
+
+```javascript
+import { download } from '@tauri-apps/plugin-upload'
+
+download(
+  'https://example.com/file-download-link',
+  './path/to/save/my/file.txt',
+  ({ progressTotal, total }) =>
+    console.log(`Downloaded ${progressTotal} of ${total} bytes`), // a callback that will be called with the download progress
+  { 'Content-Type': 'text/plain' } // optional headers to send with the request
+)
+```
+
+## Contributing
+
+PRs accepted. Please make sure to read the Contributing Guide before making a pull request.
+
+## Partners
+
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="middle">
+        <a href="https://crabnebula.dev" target="_blank">
+          <img src="https://github.com/tauri-apps/plugins-workspace/raw/v2/.github/sponsors/crabnebula.svg" alt="CrabNebula" width="283">
+        </a>
+      </td>
+    </tr>
+  </tbody>
+</table>
+
+For the complete list of sponsors please visit our [website](https://tauri.app#sponsors) and [Open Collective](https://opencollective.com/tauri).
+
+## License
+
+Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.
+
+MIT or MIT/Apache 2.0 where applicable.