zopassport 0.1.0 → 0.1.3

package/README.md

@@ -1,8 +1,10 @@
-# 🌍 Zo Passport SDK
+# Zo Passport SDK
 
-> **One line reputation to rule the world**
->
-> Phone OTP → Avatar → Passport → Wallet
+**A trans-dimensional reputation system**
+
+> One line reputation to rule the world
+
+**Flow:** Phone OTP → Avatar → Passport → Wallet
 
 Complete authentication, onboarding, and passport experience for Zo World applications.
 
@@ -26,11 +28,11 @@ cp .env.example .env
 npm install && npm run dev
 ```
 
-**That's it!** 🎉 Your full Zo Passport app is running at `http://localhost:5173`
+That's it! 🎉 Your full Zo Passport app is running at http://localhost:5173
 
-🔑 Get your client key at: **[https://zo.xyz/developers](https://zo.xyz/developers)**
+🔑 **Get your client key from a Zo House near you**
 
-📖 [**Full Installation Guide →**](./INSTALL.md)
+📦 **Repository:** https://github.com/ZoHouse/zopassport
 
 ---
 
@@ -38,10 +40,10 @@ npm install && npm run dev
 
 After `npm install zopassport`, you get:
 
-✅ **Complete Demo App** - Full working phone → passport → wallet flow
-✅ **All Dependencies** - React, Vite, TypeScript pre-configured
-✅ **All Assets** - Images, videos, icons bundled
-✅ **Environment Template** - Just add your client key
+- ✅ **Complete Demo App** - Full working phone → passport → wallet flow
+- ✅ **All Dependencies** - React, Vite, TypeScript pre-configured
+- ✅ **All Assets** - Images, videos, icons bundled
+- ✅ **Environment Template** - Just add your client key
 
 ---
 
@@ -51,7 +53,7 @@ Want to integrate into your existing app? Use it as a library:
 
 ### 1. Initialize the SDK
 
-```typescript
+```javascript
 import { ZoPassportSDK } from 'zopassport';
 
 const sdk = new ZoPassportSDK({
@@ -62,8 +64,14 @@ const sdk = new ZoPassportSDK({
 
 ### 2. React Integration
 
-```tsx
-import { ZoPassportProvider, useZoPassport, ZoLanding, ZoOnboarding, ZoPassportCard } from 'zopassport/react';
+```jsx
+import {
+  ZoPassportProvider,
+  useZoPassport,
+  ZoLanding,
+  ZoOnboarding,
+  ZoPassportCard
+} from 'zopassport/react';
 
 function App() {
   return (
@@ -101,6 +109,8 @@ function YourApp() {
 }
 ```
 
+---
+
 ## Features
 
 ### ✅ Authentication
@@ -123,12 +133,14 @@ function YourApp() {
 - Location detection
 - Avatar preview
 
+---
+
 ## Components
 
 ### `<ZoLanding />`
 Full-screen landing page with video background and auth modal.
 
-```tsx
+```jsx
 <ZoLanding
   onAuthSuccess={(userId, user) => {}}
   sendOTP={async (code, phone) => sdk.auth.sendOTP(code, phone)}
@@ -142,7 +154,7 @@ Full-screen landing page with video background and auth modal.
 ### `<ZoOnboarding />`
 Complete onboarding flow component.
 
-```tsx
+```jsx
 <ZoOnboarding
   onComplete={(data) => console.log(data)}
   updateProfile={(updates) => sdk.updateProfile(updates)}
@@ -153,7 +165,7 @@ Complete onboarding flow component.
 ### `<ZoPassportCard />`
 Passport card display component.
 
-```tsx
+```jsx
 <ZoPassportCard
   profile={{
     avatar: 'https://...',
@@ -167,7 +179,7 @@ Passport card display component.
 ### `<ZoAuth />`
 Standalone phone OTP authentication component.
 
-```tsx
+```jsx
 <ZoAuth
   onSuccess={(userId, user) => {}}
   onClose={() => {}}
@@ -179,12 +191,14 @@ Standalone phone OTP authentication component.
 ### `<PhoneInput />` & `<OTPInput />`
 Low-level input components for custom auth flows.
 
+---
+
 ## Hooks
 
 ### `useZoPassport()`
 Main hook for authentication state and operations.
 
-```tsx
+```javascript
 const {
   sdk,
   user,
@@ -200,7 +214,7 @@ const {
 ### `useProfile()`
 Profile operations and completion tracking.
 
-```tsx
+```javascript
 const {
   user,
   completion,
@@ -213,7 +227,7 @@ const {
 ### `useAvatar()`
 Avatar generation operations.
 
-```tsx
+```javascript
 const {
   avatarUrl,
   isGenerating,
@@ -221,6 +235,8 @@ const {
 } = useAvatar();
 ```
 
+---
+
 ## Assets Required
 
 Include these assets in your `public/` folder:
@@ -255,22 +271,27 @@ public/
     └── rank1.jpeg                   # Fallback avatar
 ```
 
+---
+
 ## CDN Assets
 
 The SDK uses these CDN URLs for passport backgrounds:
 
-- **Founder Background**: `https://proxy.cdn.zo.xyz/gallery/media/images/a1659b07-94f0-4490-9b3c-3366715d9717_20250515053726.png`
-- **Citizen Background**: `https://proxy.cdn.zo.xyz/gallery/media/images/bda9da5a-eefe-411d-8d90-667c80024463_20250515053805.png`
+- **Founder Background:** `https://proxy.cdn.zo.xyz/gallery/media/images/a1659b07-94f0-4490-9b3c-3366715d9717_20250515053726.png`
+- **Citizen Background:** `https://proxy.cdn.zo.xyz/gallery/media/images/bda9da5a-eefe-411d-8d90-667c80024463_20250515053805.png`
 
 You can override these via props.
 
+---
+
 ## Storage Adapters
 
 ### Web (Default)
 Uses `localStorage` automatically.
 
 ### React Native
-```tsx
+
+```javascript
 import AsyncStorage from '@react-native-async-storage/async-storage';
 import { ZoPassportSDK, AsyncStorageAdapter } from 'zopassport';
 
@@ -281,7 +302,8 @@ const sdk = new ZoPassportSDK({
 ```
 
 ### Server-Side / Testing
-```tsx
+
+```javascript
 import { ZoPassportSDK, MemoryStorageAdapter } from 'zopassport';
 
 const sdk = new ZoPassportSDK({
@@ -290,6 +312,8 @@ const sdk = new ZoPassportSDK({
 });
 ```
 
+---
+
 ## TypeScript
 
 Full TypeScript support with exported types:
@@ -303,9 +327,7 @@ import type {
 } from 'zopassport';
 ```
 
-## License
-
-MIT © Zo World Team
+---
 
 ## Wallet Integration
 
@@ -313,7 +335,7 @@ The SDK includes a built-in wallet system for managing Zo World assets.
 
 ### Framework-Agnostic Usage
 
-```typescript
+```javascript
 // Get wallet balance
 const balance = await sdk.wallet.getBalance();
 console.log('Balance:', balance.total_amount);
@@ -327,24 +349,24 @@ console.log('Transactions:', transactions);
 
 The SDK provides ready-to-use wallet components:
 
-```tsx
+```jsx
 import { WalletScreen, WalletCard } from 'zopassport/react';
 
 // Full wallet screen
 <WalletScreen onBack={() => console.log('Back')} />
 
 // Wallet card widget
-<WalletCard 
-  balance={100} 
-  user={user} 
-  isOpen={isOpen} 
-  onToggle={() => setIsOpen(!isOpen)} 
+<WalletCard
+  balance={100}
+  user={user}
+  isOpen={isOpen}
+  onToggle={() => setIsOpen(!isOpen)}
 />
 ```
 
 ### React Hooks
 
-```tsx
+```jsx
 import { useWalletBalance, useTransactions } from 'zopassport/react';
 
 const MyWallet = () => {
@@ -355,6 +377,8 @@ const MyWallet = () => {
 };
 ```
 
+---
+
 ## Universal UI Support (Web + Mobile)
 
 The SDK's UI components are built with React Native but can run on the web using `react-native-web`.
@@ -405,3 +429,8 @@ module.exports = withTM({
 });
 ```
 
+---
+
+## License
+
+MIT © Zo World Team

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zopassport",
-  "version": "0.1.0",
+  "version": "0.1.3",
   "description": "Zo Passport SDK - Phone to Avatar to Passport. Complete authentication and onboarding flow for Zo World.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -47,7 +47,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/zo-world/zopassport.git"
+    "url": "https://github.com/ZoHouse/zopassport.git"
   },
   "homepage": "https://zo.xyz",
   "bugs": {

package/scripts/init.js

@@ -174,7 +174,7 @@ async function init() {
     log('║                                                            ║', GREEN);
     log('║  2. Edit .env with your Zo client key:                    ║', GREEN);
     log('║     ' + BOLD + 'VITE_ZO_CLIENT_KEY=your-key-here' + RESET + GREEN + '                    ║', GREEN);
-    log('║     Get your key: https://zo.xyz/developers               ║', GREEN);
+    log('║     Get token from a Zo House near you                    ║', GREEN);
     log('║                                                            ║', GREEN);
     log('║  3. Install dependencies:                                 ║', GREEN);
     log('║     ' + BOLD + 'npm install' + RESET + GREEN + '                                          ║', GREEN);