Update readme

Author: ardier16

CHANGELOG.md

@@ -3,6 +3,8 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog], and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
+### Changed
+- `core` - Update example usage in README.md
 
 ## [0.5.0] - 2025-09-23
 ### Changed

packages/core/README.md

@@ -1,6 +1,6 @@
 # Unforgettable SDK
 
-`UnforgettableSdk` is a secure client-side toolkit used for key exchange and recovery within the [Unforgettable.app](https://unforgettable.app) ecosystem. It allows you to generate protected recovery links and retrieve encrypted secrets using a private RSA key pair.
+`Unforgettable SDK` is a secure client-side toolkit used for key exchange and recovery within the [Unforgettable.app](https://unforgettable.app) ecosystem. It allows you to generate secure links to Unforgettable.app and retrieve a private key recovered from the specified factors.
 
 ---
 
@@ -12,29 +12,88 @@ yarn add @rarimo/unforgettable-sdk
 
 ## Usage
 
-### Quick Start
+### Create recovery key
+
+1. Create a new SDK instance:
 
 ```ts
-import { UnforgettableSdk } from '@rarimo/unforgettable-sdk'
+import { UnforgettableSdk, RecoveryFactor } from '@rarimo/unforgettable-sdk'
+
+const sdk = new UnforgettableSdk({
+  // 'create' for creating a new key, 'restore' for recovering an existing one
+  mode: 'create',
+  // Optional, defaults to 'https://unforgettable.app'
+  appUrl: 'https://custom.app',
+  // Optional, defaults to 'https://api.unforgettable.app'
+  apiUrl: 'https://api.custom.app',
+  // Factors to use for recovery. If not provided, the user will select them during the recovery process.
+  factors: [RecoveryFactor.Face, RecoveryFactor.Image, RecoveryFactor.Password]
+})
+```
 
-// Initialize SDK in "create" or "restore" mode
-const sdk = new UnforgettableSdk({ mode: 'create' })
+2. Generate a secure recovery URL to share:
 
-// Generate a secure recovery URL to share
+```ts
 const recoveryUrl = await sdk.getRecoveryUrl()
+// You can now share this URL or display it as a QR code.
+// This is a direct link to Unforgettable.app with embedded necessary query parameters.
 console.log('Recovery URL:', recoveryUrl)
+```
+
+3. Get the recovered key and helper data URL:
 
-// Later: recover the secret key
-const recoveredKey = await sdk.getRecoveredKey()
-console.log('Recovered Key:', recoveredKey)
+```ts
+try {
+  const recoveryKey = await sdk.getRecoveredKey()
+  // This is the recovered Unforgettable private key.
+  // You can now create a wallet with it.
+  console.log('Recovered key:', recoveryKey)
+} catch (error) {
+  if (error?.httpStatus === 404) {
+    // No recovery data found yet, try again later
+   } else {
+    console.error('Recovery error:', error)
+   }
+}
 ```
 
-## Security Notes
+### Restore existing key
+
+1. Create a new SDK instance with the wallet address:
 
-- RSA keys are generated entirely on the client.
-- The private key never leaves the client environment.
-- Only the public key is sent in the URL (encoded in base64url).
-- Cryptographic operations use
+```ts
+import { UnforgettableSdk, RecoveryFactor } from '@rarimo/unforgettable-sdk'
+
+const sdk = new UnforgettableSdk({
+  mode: 'restore',
+  walletAddress: '0x1234...abcd', // The wallet address associated with the key to recover
+  appUrl: 'https://custom.app', // Optional
+  apiUrl: 'https://api.custom.app', // Optional
+  factors: [RecoveryFactor.Face, RecoveryFactor.Image, RecoveryFactor.Password] // Optional
+})
+```
+
+2. Generate a secure recovery URL to share:
+
+```ts
+const recoveryUrl = await sdk.getRecoveryUrl()
+console.log('Recovery URL:', recoveryUrl)
+```
+
+3. Get the recovered key:
+
+```ts
+try {
+  const recoveryKey = await sdk.getRecoveredKey()
+  console.log('Recovered key:', recoveryKey)
+} catch (error) {
+  if (error?.httpStatus === 404) {
+    // No recovery data found yet, try again later
+   } else {
+    console.error('Recovery error:', error)
+   }
+}
+```
 
 ## License
 

packages/react/README.md

@@ -7,7 +7,7 @@ This package makes it easy to integrate identity verification into your React ap
 
 - Simple QR code component for React
 - Works with [Unforgettable SDK core library](https://github.com/rarimo/unforgettable-sdk/tree/main/packages/core)
-- Supports **create** and **restore** (basic & advanced verification modes)
+- Supports **create** and **restore** modes
 - Built-in polling with success/error callbacks
 - Fully customizable via props
 
@@ -45,13 +45,17 @@ This component renders a QR code inside an `<a>` tag that links to the identity
 ### Example usage
 
 ```tsx
+import UnforgettableQrCode from '@rarimo/unforgettable-sdk-react'
+
+// ...
+
 <UnforgettableQrCode
-  mode={'create'}
-  onSuccess={key => console.log('Recovered:', key)}
-  onError={error => console.error(error)}
+  mode='create'
   qrProps={{ size: 200 }}
-  style={{ margin: '2rem auto', display: 'block' }}
   loader={<span>Loading...</span>}
+  style={{ margin: '2rem auto', display: 'block' }}
+  onSuccess={key => console.log('Recovered:', key)}
+  onError={error => console.error(error)}
 />
 ```