Skip to content

Commit 4a1d8a5

Browse files
committed
chore: update readme
1 parent df3cafb commit 4a1d8a5

1 file changed

Lines changed: 19 additions & 4 deletions

File tree

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
</picture>
55
</a>
66

7-
# react-native-nitro-cloud-uploader (Beta)
7+
# react-native-nitro-cloud-uploader (Beta)
88

9-
A **React Native Nitro Module** for **reliable, resumable, background-friendly uploads** of large files (audio, video, images, PDFs) to **S3-compatible storage** — built for real production workloads.
9+
**React Native Nitro Module** for **reliable, resumable, background-friendly uploads** of large files (audio, video, images, PDFs) to **S3-compatible storage** — built for real production workloads.
1010

1111
---
1212

@@ -32,7 +32,7 @@ npm install react-native-nitro-cloud-uploader react-native-nitro-modules
3232
> [!IMPORTANT]
3333
>
3434
> - All of my users are on **iOS in the US**, so iOS support is complete.
35-
> - Android support is **not fully implemented yet andd does not work!**.
35+
> - Android support is **not fully implemented yet andd does not work and should not used for now!**.
3636
> - PRs for Kotlin / Android support are absolutely welcome!
3737
3838
---
@@ -45,13 +45,28 @@ npm install react-native-nitro-cloud-uploader react-native-nitro-modules
4545
</tr>
4646
<tr>
4747
<td align="center">
48-
<video src="https://github.com/user-attachments/assets/5fa5c82d-054c-46a2-bfec-4a0b4398576f" height="650" width="300" controls></video>
48+
<video src="https://github.com/user-attachments/assets/f6c23e68-5e3f-4538-9c78-877208847bfc" height="650" width="300" controls></video>
4949
</td>
5050
</tr>
5151
</table>
5252

5353
---
5454

55+
> [!INFO]
56+
> S3 multipart **PUT** uploads require a **minimum chunk size of 5 MB**, so this library defaults to splitting files into 5 MB parts to prevent upload issues.
57+
>
58+
> You must implement your own backend endpoint to generate the multipart presigned URLs. Once provided, the library automatically handles uploading each part and storing the returned **ETag** values for you.
59+
60+
61+
```tsx
62+
const BASE_URL = 'https://api.uploader.com/file-uploader';
63+
const CREATE_UPLOAD_URL = `${BASE_URL}/create-and-start-upload`;
64+
const COMPLETE_UPLOAD_URL = `${BASE_URL}/complete-upload`;
65+
const ABORT_UPLOAD_URL = `${BASE_URL}/abort-upload`;
66+
```
67+
68+
---
69+
5570
## 🧠 Overview
5671

5772
| Feature | Support |

0 commit comments

Comments
 (0)