@worldcoin/idkit 2.4.2 → 4.0.0-dev.fe98789

package/README.md

@@ -1,68 +1,51 @@
-# IDKit JS Widget
+# @worldcoin/idkit
 
-This folder (`/idkit`) contains the main code for the widget. For instructions on **how to use the widget**, please refer to the repository's main [README](/README.md).
+React SDK for World ID built on top of `@worldcoin/idkit-core`.
 
-## ℹ️ About the Codebase
+## Highlights
 
--   The widget is made to work mainly with vanilla JS code (no framework required). The starting point can be found in `src/vanilla.tsx`.
--   The React wrapper is found on `src/components/IDKitWidget/index.ts`.
+- Headless hooks for custom UI
+- Built-in controlled widgets with shadow DOM isolation
+- Separate request and session APIs
 
-## 🧑‍💻 Development & Testing
+## Installation
 
-To develop locally and contribute to this package, you can simply follow these instructions after cloning the repo.
+```bash
+npm install @worldcoin/idkit
+```
 
--   Install dependencies
-    ```bash
-    # be sure to run this in the root folder of the repo
-    yarn install
-    ```
--   Run tests
-    ```bash
-    # runs in the /idkit folder
-    cd idkit/
-    yarn test
-    ```
--   Run local test project
-    ```bash
-    # runs in the /idkit folder
-    yarn dev
-    ```
--   Open browser at `http://localhost:3000`
--   To build the production bundle you can simply run.
-    ```bash
-    # runs in the /idkit folder
-    yarn build
-    ```
+## Basic usage
 
-## Usage
-
-### Set Language Explicitly
 ```tsx
-  <IDKitWidget
-    app_id="your_app_id"
-    action="your_action"
-    onSuccess={handleSuccess}
-    language="es" // Spanish
-  >
-    {({ open }) => <button onClick={open}>Verify with World ID</button>}
-  </IDKitWidget>
-  ```
- 
-  ### Automatic Language Detection (Default)
-  ```tsx
-  <IDKitWidget
-    app_id="your_app_id"
-    action="your_action"
-    onSuccess={handleSuccess}
-    // No language prop needed - will auto-detect
-  >
-    {({ open }) => <button onClick={open}>Verify with World ID</button>}
-  </IDKitWidget>
-  ```
-
-## Supported Languages
+import { useIDKitRequest, orbLegacy } from "@worldcoin/idkit";
+
+function Example() {
+  const flow = useIDKitRequest({
+    app_id: "app_xxxxx",
+    action: "my-action",
+    rp_context,
+    allow_legacy_proofs: false,
+    preset: orbLegacy({ signal: "user-123" }),
+  });
+  const isBusy =
+    flow.isAwaitingUserConnection || flow.isAwaitingUserConfirmation;
+
+  return (
+    <button onClick={flow.open} disabled={isBusy}>
+      Verify
+    </button>
+  );
+}
+```
 
-Currently supported languages:
-- `en` - English (default)
-- `es` - Spanish
-- `th` - Thai
+```tsx
+import type { IDKitRequestHookConfig } from "@worldcoin/idkit";
+
+const config: IDKitRequestHookConfig = {
+  app_id: "app_xxxxx",
+  action: "my-action",
+  rp_context,
+  allow_legacy_proofs: false,
+  preset: { type: "OrbLegacy" },
+};
+```