@better-s3/react 3.1049.0 → 3.1050.0

package/README.md

@@ -1,75 +1,30 @@
 # @better-s3/react
 
-Headless React hooks for S3 upload, download, and delete — state, progress, and cancellation built in.
+Headless React hooks for S3 upload, download, and delete flows.
 
-Requires [`@better-s3/server`](../better-s3-server) on the backend. For ready-made components, see [`@better-s3/ui`](../better-s3-ui).
+Full documentation: [better-s3-docs.vercel.app](https://better-s3-docs.vercel.app/docs/react)
 
 ## Install
 
 ```bash
-pnpm add @better-s3/react @better-s3/server
+pnpm add @better-s3/react @better-s3/core
 ```
 
-## Setup
-
-```ts
-import { createS3Api } from "@better-s3/core";
-
-const api = createS3Api();
-```
-
-## Hooks
-
-| Hook                     | Use case                                |
-| ------------------------ | --------------------------------------- |
-| `useUploadControls`      | Single file — picker + drag-and-drop    |
-| `useMultiUploadControls` | Multiple files — picker + drag-and-drop |
-| `useUpload`              | Single file — call `upload()` yourself  |
-| `useMultiUpload`         | Batch — call `upload()` yourself        |
-| `useDownload`            | Presigned URL → native browser download |
-| `useFetchDownload`       | Fetch with progress and cancel          |
-| `useDelete`              | Two-step delete with confirmation       |
-
-### Upload — single file
-
-```tsx
-const { openFilePicker, inputProps, dropHandlers, progress, isUploading } =
-  useUploadControls({
-    api,
-    objectKey: (file) => `uploads/${file.name}`,
-    accept: ["image/*"],
-    maxFileSize: 10 * 1024 * 1024,
-  });
-
-// <input {...inputProps} />
-// <div {...dropHandlers} onClick={openFilePicker}>…</div>
-```
-
-### Upload — multiple files
+## Minimal setup
 
 ```tsx
-const { openFilePicker, inputProps, files, totalProgress } =
-  useMultiUploadControls({
-    api,
-    objectKey: (file) => `uploads/${file.name}`,
-    maxFiles: 5,
-    concurrentFiles: 3,
-  });
-```
-
-### Download
+import { createS3Api } from "@better-s3/core";
+import { S3Provider, useUploadControls } from "@better-s3/react";
 
-```tsx
-const { download } = useDownload({ api });
-download("uploads/photo.jpg", "photo.jpg");
-```
+const client = createS3Api();
 
-### Delete
+// App root
+<S3Provider client={client}>{children}</S3Provider>;
 
-```tsx
-const { requestDelete, confirmDelete } = useDelete({ api });
-requestDelete("uploads/photo.jpg");
-await confirmDelete();
+// In a component
+const { openFilePicker, inputProps } = useUploadControls({
+  objectKey: (file) => `uploads/${file.name}`,
+});
 ```
 
 ## License

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@better-s3/react",
-  "version": "3.1049.0",
+  "version": "3.1050.0",
   "description": "React hooks for S3-compatible file uploads, downloads, and deletes",
   "keywords": [
     "s3",
@@ -33,7 +33,7 @@
     "dist"
   ],
   "dependencies": {
-    "@better-s3/core": "3.1049.0"
+    "@better-s3/core": "3.1050.0"
   },
   "peerDependencies": {
     "react": ">=18"