firebase-storage-kit 1.3.0 → 1.4.0

package/README.md

@@ -2,21 +2,15 @@
 
 Storage manager for Firebase Storage with uploads, progress tracking, batch uploads, and file query helpers.
 
-## Install
+**Full documentation:** [firebase-storage-kit.vercel.app/docs](https://firebase-storage-kit.vercel.app/docs)
 
-With npm:
+## Install
 
 ```bash
-npm install firebase-storage-kit
+npm install firebase firebase-storage-kit
 ```
 
-Or with Yarn, pnpm, or Bun:
-
-```bash
-yarn add firebase-storage-kit
-pnpm add firebase-storage-kit
-bun add firebase-storage-kit
-```
+Also works with Yarn, pnpm, or Bun. See [Installation](https://firebase-storage-kit.vercel.app/docs/getting-started/installation) for all package managers.
 
 ## Quick start
 
@@ -38,84 +32,24 @@ handle.on("success", (upload) => {
 });
 ```
 
-### Batch uploads
-
-```ts
-const batch = manager.uploadFiles(
-  files,
-  (file) => ({ path: `uploads/${file.name}` }),
-  { concurrency: 3, continueOnError: true },
-);
-
-batch.on("success", (snapshot) => {
-  console.log(snapshot.completedCount, snapshot.failedCount);
-});
-```
-
-### Subscriptions (manager state)
-
-```ts
-const unsubscribe = manager.subscribe((state) => {
-  console.log(state.uploads, state.batches);
-});
-```
-
-### Custom metadata
-
-Attach app-specific metadata when uploading. Read it back later with `getMetadata`:
-
-```ts
-const handle = manager.uploadFile(file, {
-  path: `uploads/${file.name}`,
-  customMetadata: {
-    owner: "user-123",
-    source: "mobile-app",
-  },
-});
-
-const meta = await manager.getMetadata(`uploads/${file.name}`);
-console.log(meta.customMetadata?.owner);
-```
-
-Works with batch uploads too — use `customMetadata` in the `UploadOptions` for each file.
+### React
 
-#### Caveats
+```tsx
+import { useStorageManager, useUpload } from "firebase-storage-kit/react";
 
-- **String values only.** Keys and values must both be strings (`Record<string, string>`).
-- **Reserved keys.** Client apps cannot set internal keys such as `firebaseStorageDownloadTokens`; Firebase rejects those with a 400 error.
-- **Small data only.** Custom metadata is for lightweight, file-specific tags. For richer or queryable data, use Firestore or Realtime Database instead.
-- **Security rules.** Who can read or write metadata is controlled by your Firebase Storage security rules — configure them if metadata is sensitive.
-
-### Upload retries
-
-Uploads retry transient failures automatically (3 retries by default, exponential backoff with jitter). Pass `retry: false` to disable, or customize:
-
-```ts
-const handle = manager.uploadFile(file, {
-  path: `uploads/${file.name}`,
-  retry: { maxRetries: 5, initialDelayMs: 700 },
-});
-
-handle.on("retry", ({ attempt, maxAttempts, delayMs, error }) => {
-  console.log(`Retry ${attempt}/${maxAttempts} in ${delayMs}ms`, error.message);
-});
+const manager = useStorageManager(storage);
+const handle = manager.uploadFile(file, { path: `uploads/${file.name}` });
+const upload = useUpload(handle);
 ```
 
-### Querying files
+See [React hooks](https://firebase-storage-kit.vercel.app/docs/guides/react-hooks).
 
-```ts
-const exists = await manager.exists("uploads/photo.jpg");
-
-if (exists) {
-  const meta = await manager.getMetadata("uploads/photo.jpg");
-  const url = await manager.getDownloadURL("uploads/photo.jpg");
-  console.log(meta.size, url);
-}
-
-await manager.delete("uploads/old.jpg");
-```
+## Learn more
 
-`exists` returns `false` only when the object is not found. Permission and network errors are thrown.
+- [Single upload](https://firebase-storage-kit.vercel.app/docs/getting-started/single-upload)
+- [Batch uploads](https://firebase-storage-kit.vercel.app/docs/guides/batch-uploads)
+- [API reference](https://firebase-storage-kit.vercel.app/docs/api/storage-manager)
+- [Troubleshooting](https://firebase-storage-kit.vercel.app/docs/troubleshooting)
 
 ## License