From 5c05224e42b44dc1cc12f6c50a0e0180a85455c1 Mon Sep 17 00:00:00 2001
From: Vinayak <72456774+louremipsum@users.noreply.github.com>
Date: Wed, 17 May 2023 19:07:18 +0530
Subject: [PATCH] docs(upload): documentation for download function (#362)

* feat: documentation for download func.

* fix: linguitic and header type changes
---
 plugins/upload/README.md | 20 ++++++++++++++++----
 1 file changed, 16 insertions(+), 4 deletions(-)

diff --git a/plugins/upload/README.md b/plugins/upload/README.md
index b69c8eda..0f74288d 100644
--- a/plugins/upload/README.md
+++ b/plugins/upload/README.md
@@ -1,6 +1,7 @@
 ![plugin-upload](banner.png)
 
 Upload files from disk to a remote server over HTTP.
+Download files from a remote HTTP server to disk.
 
 ## Install
 
@@ -54,10 +55,21 @@ Afterwards all the plugin's APIs are available through the JavaScript guest bind
 import { upload } from 'tauri-plugin-upload-api'
 
 upload(
-    'https://example.com/file-upload'
-    './path/to/my/file.txt'
-    (progress, total) => console.log(`Downloaded ${progress} of ${total} bytes`) // a callback that will be called with the upload progress
-    { 'ContentType': 'text/plain' } // optional headers to send with the request
+    'https://example.com/file-upload',
+    './path/to/my/file.txt',
+    (progress, total) => console.log(`Uploaded ${progress} of ${total} bytes`), // a callback that will be called with the upload progress
+    { 'Content-Type': 'text/plain' } // optional headers to send with the request
+)
+```
+
+```javascript
+import { download } from "tauri-plugin-upload-api";
+
+download(
+    'https://example.com/file-download-link',
+    './path/to/save/my/file.txt',
+    (progress, total) => console.log(`Downloaded ${progress} of ${total} bytes`), // a callback that will be called with the download progress
+    { 'Content-Type': 'text/plain' } // optional headers to send with the request
 )
 ```