@cofhe/react 0.1.0 → 0.2.0

package/README.md

@@ -1,13 +1,13 @@
-# @cofhesdk/react
+# @cofhe/react
 
 React component and hook for the CoFHE SDK - featuring the advanced FnxEncryptInput component.
 
 ## Installation
 
 ```bash
-npm install @cofhesdk/react @cofhesdk/web @cofhesdk/adapters @mui/icons-material @mui/material
+npm install @cofhe/react @cofhe/sdk @mui/icons-material @mui/material
 # or
-pnpm add @cofhesdk/react @cofhesdk/web @cofhesdk/adapters @mui/icons-material @mui/material
+pnpm add @cofhe/react @cofhe/sdk @mui/icons-material @mui/material
 ```
 
 ## Quick Start
@@ -15,9 +15,9 @@ pnpm add @cofhesdk/react @cofhesdk/web @cofhesdk/adapters @mui/icons-material @m
 ### 1. Wrap your app with CofheProvider
 
 ```tsx
-import { CofheProvider } from '@cofhesdk/react';
-import '@cofhesdk/react/styles.css'; // Import component styles
-import { createCofhesdkClient } from '@cofhesdk/web';
+import { CofheProvider } from '@cofhe/react';
+import '@cofhe/react/styles.css'; // Import component styles
+import { createCofhesdkClient } from '@cofhe/sdk/web';
 
 const client = createCofhesdkClient(config);
 
@@ -33,7 +33,7 @@ function App() {
 ### 2. Use the FnxEncryptInput component
 
 ```tsx
-import { FnxEncryptInput, FheTypesList } from '@cofhesdk/react';
+import { FnxEncryptInput, FheTypesList } from '@cofhe/react';
 
 function MyComponent() {
   return (
@@ -51,7 +51,7 @@ function MyComponent() {
 ### 3. Use the hook directly for custom implementations
 
 ```tsx
-import { useEncryptInput } from '@cofhesdk/react';
+import { useEncryptInput } from '@cofhe/react';
 
 function CustomComponent() {
   const { onEncryptInput, isEncryptingInput, encryptionProgress } = useEncryptInput();
@@ -80,6 +80,7 @@ function CustomComponent() {
 Advanced input component with integrated features:
 
 ### Features
+
 - ✅ **Type Selection Dropdown** - Choose from uint8, uint16, uint32, uint64, uint128, bool, address
 - ✅ **Real-time Input Validation** - Validates input against selected FHE type
 - ✅ **Progress Tracking** - Shows encryption steps with progress bar
@@ -119,12 +120,12 @@ Hook for custom encryption workflows with progress tracking:
 
 ```tsx
 const {
-  onEncryptInput,           // (type, value) => Promise<encrypted>
-  isEncryptingInput,        // boolean - encryption in progress
-  encryptionStep,           // Current step: 'fetchKeys' | 'pack' | 'prove' | 'verify' | 'done'
-  encryptionProgress,       // Progress percentage (0-100)
-  encryptionProgressLabel,  // Human-readable progress label
-  inputEncryptionDisabled,  // boolean - whether encryption is disabled
+  onEncryptInput, // (type, value) => Promise<encrypted>
+  isEncryptingInput, // boolean - encryption in progress
+  encryptionStep, // Current step: 'fetchKeys' | 'pack' | 'prove' | 'verify' | 'done'
+  encryptionProgress, // Progress percentage (0-100)
+  encryptionProgressLabel, // Human-readable progress label
+  inputEncryptionDisabled, // boolean - whether encryption is disabled
 } = useEncryptInput();
 ```
 
@@ -133,7 +134,7 @@ const {
 The package includes Tailwind CSS styles. Import them in your app:
 
 ```tsx
-import '@cofhesdk/react/styles.css';
+import '@cofhe/react/styles.css';
 ```
 
 If you're using Tailwind CSS in your project, the component classes will work automatically.
@@ -141,16 +142,18 @@ If you're using Tailwind CSS in your project, the component classes will work au
 ## Dependencies
 
 ### Required Peer Dependencies
+
 - `@mui/icons-material` ^5.0.0
-- `@mui/material` ^5.0.0  
+- `@mui/material` ^5.0.0
 - `react` ^16.8.0 || ^17.0.0 || ^18.0.0
 - `react-dom` ^16.8.0 || ^17.0.0 || ^18.0.0
 
 ### CoFHE SDK Dependencies
-- `@cofhesdk/web` - Web-specific CoFHE SDK
-- `@cofhesdk/adapters` - Provider adapters
-- `@cofhesdk/chains` - Chain configurations
+
+- `@cofhe/sdk/web` - Web-specific CoFHE SDK
+- `@cofhe/sdk/adapters` - Provider adapters
+- `@cofhe/sdk/chains` - Chain configurations
 
 ## Example
 
-See the complete example application in the `/example` directory of this repository for interactive demonstrations of all features.
+See the complete example application in the `/example` directory of this repository for interactive demonstrations of all features.