From 9fabb9181ab566a4c81e0afab34a19c70272a8be Mon Sep 17 00:00:00 2001 From: marknesh Date: Fri, 3 Jul 2026 23:39:26 +0300 Subject: [PATCH 1/2] chore: add Socket Badge --- .github/README.md | 2 ++ packages/firebase-storage-kit/README.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/.github/README.md b/.github/README.md index 4f1a790..80d7586 100644 --- a/.github/README.md +++ b/.github/README.md @@ -1,5 +1,7 @@ # firebase-storage-kit +[![Socket Badge](https://socket.dev/api/badge/npm/package/firebase-storage-kit)](https://socket.dev/npm/package/firebase-storage-kit) + Storage manager for Firebase Storage with uploads, progress tracking, batch uploads, and file query helpers. **Full documentation:** [firebase-storage-kit.vercel.app/docs](https://firebase-storage-kit.vercel.app/docs) diff --git a/packages/firebase-storage-kit/README.md b/packages/firebase-storage-kit/README.md index 4f1a790..80d7586 100644 --- a/packages/firebase-storage-kit/README.md +++ b/packages/firebase-storage-kit/README.md @@ -1,5 +1,7 @@ # firebase-storage-kit +[![Socket Badge](https://socket.dev/api/badge/npm/package/firebase-storage-kit)](https://socket.dev/npm/package/firebase-storage-kit) + Storage manager for Firebase Storage with uploads, progress tracking, batch uploads, and file query helpers. **Full documentation:** [firebase-storage-kit.vercel.app/docs](https://firebase-storage-kit.vercel.app/docs) From 9c795cdc2dc0f400ed0fc583bc8acc983ca57b47 Mon Sep 17 00:00:00 2001 From: marknesh Date: Fri, 3 Jul 2026 23:47:10 +0300 Subject: [PATCH 2/2] add readme symlink --- .github/README.md | 59 +---------------------------------------------- 1 file changed, 1 insertion(+), 58 deletions(-) mode change 100644 => 120000 .github/README.md diff --git a/.github/README.md b/.github/README.md deleted file mode 100644 index 80d7586..0000000 --- a/.github/README.md +++ /dev/null @@ -1,58 +0,0 @@ -# firebase-storage-kit - -[![Socket Badge](https://socket.dev/api/badge/npm/package/firebase-storage-kit)](https://socket.dev/npm/package/firebase-storage-kit) - -Storage manager for Firebase Storage with uploads, progress tracking, batch uploads, and file query helpers. - -**Full documentation:** [firebase-storage-kit.vercel.app/docs](https://firebase-storage-kit.vercel.app/docs) - -## Install - -```bash -npm install firebase 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 - -```ts -import { getStorage } from "firebase/storage"; -import { StorageManager } from "firebase-storage-kit"; - -const storage = getStorage(app); -const manager = new StorageManager(storage); - -const handle = manager.uploadFile(file, { path: `uploads/${file.name}` }); - -handle.on("progress", (upload) => { - console.log(upload.progress); -}); - -handle.on("success", (upload) => { - console.log(upload.downloadURL); -}); -``` - -### React - -```tsx -import { useStorageManager, useUpload } from "firebase-storage-kit/react"; - -const manager = useStorageManager(storage); -const handle = manager.uploadFile(file, { path: `uploads/${file.name}` }); -const upload = useUpload(handle); -``` - -See [React hooks](https://firebase-storage-kit.vercel.app/docs/guides/react-hooks). - -## Learn more - -- [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 - -MIT diff --git a/.github/README.md b/.github/README.md new file mode 120000 index 0000000..cb82f95 --- /dev/null +++ b/.github/README.md @@ -0,0 +1 @@ +../packages/firebase-storage-kit/README.md \ No newline at end of file