Publish the SDK under the Gnosys Labs npm organization
Hop-State: A_06FPAHQDE2YC3AQWGQGNQN0 Hop-Proposal: R_06FPAHP3Q77W9A2D641H4SR Hop-Task: T_06FPAH33SHXWSFZ2V45R2Z8 Hop-Attempt: AT_06FPAH33SGNKEM8JTS1KX70
This commit is contained in:
@@ -1,14 +1,14 @@
|
||||
# `@stuffbox/sdk`
|
||||
# `@gnosyslabs/stuffbox-sdk`
|
||||
|
||||
The official TypeScript SDK for connecting applications to Stuffbox, a user-owned media library. The package includes a framework-neutral client, shared API types, PKCE helpers, typed errors, and optional React upload helpers.
|
||||
|
||||
## Install
|
||||
|
||||
```sh
|
||||
npm install @stuffbox/sdk
|
||||
npm install @gnosyslabs/stuffbox-sdk
|
||||
```
|
||||
|
||||
The core entry point has no runtime dependencies. If you use `@stuffbox/sdk/react`, install React 18.2 or React 19 in your application.
|
||||
The core entry point has no runtime dependencies. If you use `@gnosyslabs/stuffbox-sdk/react`, install React 18.2 or React 19 in your application.
|
||||
|
||||
## Connect a user
|
||||
|
||||
@@ -19,7 +19,7 @@ import {
|
||||
StuffboxClient,
|
||||
createPkcePair,
|
||||
generateState,
|
||||
} from "@stuffbox/sdk";
|
||||
} from "@gnosyslabs/stuffbox-sdk";
|
||||
|
||||
const stuffbox = new StuffboxClient({ baseUrl: "https://stuffbox.xyz" });
|
||||
const pkce = await createPkcePair();
|
||||
@@ -85,7 +85,7 @@ Request only the permissions your feature uses: `assets:read`, `assets:write`, a
|
||||
The optional React entry point exports `useStuffboxUpload`, `uploadFile`, and their types:
|
||||
|
||||
```tsx
|
||||
import { useStuffboxUpload, type UploadTransport } from "@stuffbox/sdk/react";
|
||||
import { useStuffboxUpload, type UploadTransport } from "@gnosyslabs/stuffbox-sdk/react";
|
||||
|
||||
const transport: UploadTransport = {
|
||||
async createUpload(input, options) {
|
||||
|
||||
Reference in New Issue
Block a user