@neus/sdk 1.0.2 → 1.0.4

package/widgets/README.md

@@ -1,6 +1,6 @@
-# NEUS Widgets (VerifyGate + ProofBadge)
+# NEUS Widgets
 
-React components for NEUS verification and access gating.
+**Proof-aware React components** (VerifyGate, ProofBadge) so your UI can show verified state and gate content **using the same checks your server already trusts** - avoid re-implementing verifier rules only in the browser.
 
 ## Install
 
@@ -10,7 +10,7 @@ npm install @neus/sdk react react-dom
 
 ## VerifyGate
 
-Gate UI behind verification requirements.
+Create mode defaults to **unlisted public** for gate-friendly reuse. Override `proofOptions` when you need listed public or private.
 
 ```jsx
 import { VerifyGate } from '@neus/sdk/widgets';
@@ -18,9 +18,10 @@ import { VerifyGate } from '@neus/sdk/widgets';
 export function Page() {
   return (
     <VerifyGate
+      appId="your-app-id"
       requiredVerifiers={['nft-ownership']}
       verifierData={{
-        'nft-ownership': { contractAddress: '0x...', tokenId: '1', chainId: 1 }
+        'nft-ownership': { contractAddress: '0x...', tokenId: '1', chainId: 8453 }
       }}
     >
       <div>Unlocked</div>
@@ -29,25 +30,16 @@ export function Page() {
 }
 ```
 
-### Key props
-
-- `requiredVerifiers`: `string[]` (default: `['ownership-basic']`)
-- `verifierData`: object keyed by verifier id
-- `strategy`: `'reuse-or-create' | 'reuse' | 'fresh'` (default: `'reuse-or-create'`)
-- `proofOptions`: `{ privacyLevel, publicDisplay, storeOriginalContent, enableIpfs? }` (defaults: private)
-- `mode`: `'create' | 'access'` (default: `'create'`)
-- `qHash`: string (required for `mode="access"`)
-
-Notes:
-- Reuse without prompting can only see **public + discoverable** proofs.
-- Reusing private proofs requires an **owner signature** (wallet grants read access).
-
 ## ProofBadge
 
-Display verification status by Proof ID (`qHash`).
-
 ```jsx
 import { ProofBadge } from '@neus/sdk/widgets';
 
-<ProofBadge qHash="0x..." showChains />
+<ProofBadge proofId="0x..." showChains />
 ```
+
+## Docs
+
+- [Widgets Overview](https://docs.neus.network/widgets/overview)
+- [Verify Component](https://docs.neus.network/widgets/verifygate)
+- [Quickstart](https://docs.neus.network/quickstart)

package/widgets/index.js

@@ -1,9 +1,9 @@
-/**
- * NEUS Widgets
- * 
- * Core Widgets:
- * - VerifyGate: Universal verification gate component
- * - ProofBadge: Display verification status
- */
-
-export * from './verify-gate/index.js';
+/**
+ * NEUS Widgets
+ *
+ * Core Widgets:
+ * - VerifyGate: Universal verification gate component
+ * - ProofBadge: Display verification status
+ */
+
+export * from './verify-gate/index.js';