@unvired/react-native-unvired-sdk 0.0.12 → 0.0.13

package/README.md

@@ -1,348 +1,977 @@
-# React Native Unvired SDK
+# Unvired React Native SDK
 
-A comprehensive SDK for React Native applications with support for logging, database operations, notifications, and file system management.
+A comprehensive, production-ready SDK for React Native applications providing logging, database, storage, file system, device info, and push notification capabilities.
 
-## Installation
+[![npm version](https://img.shields.io/npm/v/@unvired/react-native-unvired-sdk.svg)](https://www.npmjs.com/package/@unvired/react-native-unvired-sdk)
+[![License](https://img.shields.io/badge/license-UNLICENSED-blue.svg)](LICENSE)
 
-```bash
-npm install react-native-unvired-sdk
-# or
-yarn add react-native-unvired-sdk
+---
+
+## 📋 Table of Contents
+
+- [Features](#features)
+- [Architecture](#architecture)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Modules](#modules)
+- [Documentation](#documentation)
+- [Requirements](#requirements)
+- [License](#license)
+
+---
+
+## ✨ Features
+
+- 📝 **Advanced Logging** - File persistence, compression, rotation, and multiple log levels
+- 💾 **SQLite Database** - Both low-level and high-level ORM-like APIs
+- 🗄️ **Local Storage** - AsyncStorage wrapper with automatic JSON serialization
+- 📁 **File System** - Comprehensive file and directory operations
+- 📱 **Device Info** - Platform detection and device information
+- 🔔 **Push Notifications** - Firebase Cloud Messaging integration
+- 🔌 **Platform Adapter** - Unified interface for all platform-specific functionality
+- 🎯 **TypeScript First** - Full type safety and IntelliSense support
+- 🏗️ **Modular Architecture** - Use individual modules or the complete platform adapter
+- 🚀 **Production Ready** - Battle-tested and optimized for performance
+
+---
+
+## 🏗️ Architecture
+
+### Module Structure
+
+The SDK follows a clean, modular architecture where each module is independent and can be used separately or through the unified platform adapter.
+
+```
+src/
+├── main.ts                          # SDK Entry Point
+│
+├── logger/                          # Logger Module
+│   ├── index.ts                     # Module exports
+│   ├── BaseLogger.ts                # Core logging logic
+│   ├── Logger.types.ts              # Type definitions
+│   └── services/                    # Platform-specific implementations
+│       ├── LoggerNative.ts
+│       ├── LoggerWeb.ts
+│       └── LoggerWindows.ts
+│
+├── database/                        # Database Module
+│   ├── index.ts                     # Module exports
+│   ├── DatabaseManager.ts           # Low-level adapter
+│   ├── Database.ts                  # High-level ORM
+│   └── types.ts                     # Type definitions
+│
+├── local-storage/                   # Local Storage Module
+│   ├── index.ts                     # Module exports
+│   └── localStorage.ts              # AsyncStorage wrapper
+│
+├── device-info/                     # Device Info Module
+│   ├── index.ts                     # Module exports
+│   ├── DeviceInfo.ts                # Main class
+│   ├── BaseDeviceInfo.ts            # Core implementation
+│   └── DeviceInfo.types.ts          # Type definitions
+│
+├── file-system/                     # File System Module
+│   ├── index.ts                     # Module exports
+│   ├── FileSystem.ts                # Main class
+│   ├── BaseFileSystem.ts            # Core implementation
+│   └── FileSystem.types.ts          # Type definitions
+│
+├── push-notification/               # Push Notification Module
+│   ├── index.ts                     # Module exports
+│   ├── PushNotification.ts          # Main class
+│   ├── BasePushNotification.ts      # Core implementation
+│   └── PushNotification.types.ts    # Type definitions
+│
+└── platform/                        # Platform Adapter Module
+    ├── index.ts                     # Module exports
+    ├── Platform.ts                  # Main adapter
+    ├── BasePlatform.ts              # Core implementation
+    └── Platform.types.ts            # Type definitions
 ```
 
-### Optional Dependencies
+### Connection Flow
+
+```
+@unvired/react-native-unvired-sdk
+            ↓
+        src/main.ts (Entry Point)
+            ↓
+    ┌───────┴───────┬───────────┬──────────┬────────────┬─────────────┬──────────┐
+    ↓               ↓           ↓          ↓            ↓             ↓          ↓
+logger/         database/   local-    device-      file-        push-       platform/
+index.ts        index.ts    storage/  info/        system/      notification/ index.ts
+                            index.ts  index.ts     index.ts     index.ts
+```
 
-The **logger works out of the box** with zero dependencies. For additional features, install the packages you need:
+---
+
+## 📦 Installation
+
+### Install the SDK
 
 ```bash
-# For file operations
-npm install @dr.pogodin/react-native-fs
+npm install @unvired/react-native-unvired-sdk
+```
 
-# For database (choose one)
-npm install react-native-sqlite-storage  # SQL database
-npm install @react-native-async-storage/async-storage  # Simple key-value
+### Install Peer Dependencies
 
-# For notifications
-npm install @notifee/react-native
+```bash
+npm install react-native-device-info @dr.pogodin/react-native-fs react-native-sqlite-storage @react-native-async-storage/async-storage
 ```
 
-> **See [NPM_PACKAGES.md](./NPM_PACKAGES.md) for detailed package information and implementation guide.**
+### Optional: Push Notifications
 
-### Troubleshooting
+```bash
+npm install @react-native-firebase/app @react-native-firebase/messaging
+```
 
-If you encounter errors like:
-- `Cannot read property 'RNFSFileTypeRegular' of null`
-- `Cannot read property 'PlatformManager' of undefined`
-- Native module linking issues
+### Platform Setup
 
-**See [TROUBLESHOOTING.md](./TROUBLESHOOTING.md) for detailed solutions.**
+#### iOS
+```bash
+cd ios && pod install
+```
 
-The SDK now includes defensive checks and will gracefully handle missing native modules with helpful error messages in the console.
+#### Android
+Ensure your `android/build.gradle` has the required repositories.
 
-### Migration from react-native-fs
+---
 
-> **Note:** We now use `@dr.pogodin/react-native-fs` (actively maintained fork) instead of the deprecated `react-native-fs`.
-> 
-> If you're upgrading from an older version, see [MIGRATION_GUIDE.md](./MIGRATION_GUIDE.md) for step-by-step instructions.
+## 🚀 Quick Start
 
-## Features
+### Option 1: Use Individual Modules (Recommended)
 
-- 📝 **Logger** - Comprehensive logging with multiple log levels ✅ **No dependencies**
-- 💾 **Database** - Database operations and data persistence ⚠️ *Requires optional package*
-- 🔔 **Notifications** - Push and local notification management ⚠️ *Requires optional package*
-- 📁 **File System** - File read/write and management operations ⚠️ *Requires optional package*
-- 🔌 **PlatformInterface** - Compatible with PlatformInterface pattern for cross-platform logging
-
-## Usage
-
-### Basic Initialization
-
-```javascript
-import UnviredSDK, { LogLevel } from 'react-native-unvired-sdk';
-
-// Initialize the SDK with all modules
-await UnviredSDK.initialize({
-  logLevel: LogLevel.DEBUG,
-  tag: 'MyApp',
-  database: {
-    // Database configuration
-  },
-  notifications: {
-    // Notification configuration
-  },
-  fileSystem: {
-    basePath: '/path/to/files'
-  }
+```typescript
+import {
+  logger,
+  LocalStorage,
+  createDatabase,
+  DeviceInfo,
+  FileSystem,
+  PushNotification
+} from '@unvired/react-native-unvired-sdk';
+
+// Logger
+logger.setLogLevel('DEBUG');
+logger.logInfo('App', 'init', 'Application started');
+
+// Local Storage
+await LocalStorage.setItem('user', { name: 'John', age: 30 });
+const user = await LocalStorage.getItem('user');
+
+// Database
+const db = createDatabase('myapp');
+await db.createTable('users', {
+  id: 'INTEGER PRIMARY KEY AUTOINCREMENT',
+  name: 'TEXT NOT NULL',
+  email: 'TEXT UNIQUE'
 });
-```
+await db.insert('users', { name: 'John', email: 'john@example.com' });
 
-### Using the Logger
+// Device Info
+const platform = DeviceInfo.getPlatform(); // 'ios' or 'android'
+const deviceInfo = DeviceInfo.getDeviceInfoSync();
 
-```javascript
-import { logger, LogLevel } from 'react-native-unvired-sdk';
+// File System
+const docDir = FileSystem.getDocumentDirectory();
+await FileSystem.writeFile(`${docDir}/test.txt`, 'Hello World');
 
-// Set log level
-logger.setLogLevel(LogLevel.DEBUG);
+// Push Notifications
+const push = new PushNotification();
+await push.requestPermission();
+const token = await push.getToken();
+```
 
-// Log messages
-logger.debug('Debug message');
-logger.info('Info message');
-logger.warn('Warning message');
-logger.error('Error message');
+### Option 2: Use Platform Adapter
 
-// Create child logger for specific modules
-const childLogger = logger.createChild('FeatureModule');
-childLogger.info('This is from a child logger');
+```typescript
+import { getPlatformAdapter } from '@unvired/react-native-unvired-sdk';
+
+const platform = getPlatformAdapter();
+
+// All modules accessible through platform adapter
+const logger = platform.getLoggerAdapter();
+const storage = platform.getStorageAdapter();
+const dbAdapter = platform.getDatabaseAdapter();
+const deviceInfo = platform.getDeviceInfo();
 ```
 
-### Using PlatformInterface Pattern
+---
+
+## 📚 Modules
 
-```javascript
-import { logger } from 'react-native-unvired-sdk';
+### 1. Logger Module
 
-// Use with className and methodName (PlatformInterface compatible)
-logger.logInfo('UserService', 'login', 'User login attempt');
-logger.logError('UserService', 'login', 'Login failed');
-logger.logDebug('UserService', 'fetchProfile', 'Fetching user profile');
+Advanced logging with file persistence, compression, and rotation.
+
+```typescript
+import { logger } from '@unvired/react-native-unvired-sdk';
 
-// Set log level (accepts string)
 logger.setLogLevel('DEBUG');
+logger.logDebug('MyClass', 'myMethod', 'Debug message');
+logger.logInfo('MyClass', 'myMethod', 'Info message');
+logger.logError('MyClass', 'myMethod', 'Error message');
 
-// File-based logging
+// Get log file content
 const logs = await logger.getLogFileContent();
-const backupLogs = await logger.getBackupLogFileContent();
-await logger.clearLogFile();
 ```
 
-### Database Operations
+**Features:**
+- Multiple log levels (DEBUG, INFO, ERROR)
+- File persistence with automatic rotation
+- Compression (gzip)
+- Async operations
+- Platform-specific implementations
 
-```javascript
-import { database } from 'react-native-unvired-sdk';
+---
 
-// Initialize database (if not done in SDK initialization)
-await database.initialize({ /* config */ });
+### 2. Database Module
 
-// Insert or update data
-await database.upsert('users', {
-  id: 1,
-  name: 'John Doe',
-  email: 'john@example.com'
-});
+SQLite database with both low-level and high-level APIs.
+
+```typescript
+import { createDatabase, DatabaseManager } from '@unvired/react-native-unvired-sdk';
 
-// Query data
-const users = await database.query('users', { 
-  where: { active: true } 
+// High-level API (recommended)
+const db = createDatabase('myapp');
+await db.createTable('users', {
+  id: 'INTEGER PRIMARY KEY AUTOINCREMENT',
+  name: 'TEXT NOT NULL',
+  email: 'TEXT UNIQUE'
 });
+await db.insert('users', { name: 'John', email: 'john@example.com' });
+const users = await db.select('users');
+
+// Low-level API
+const adapter = DatabaseManager.getDatabaseAdapter();
+adapter.execute({
+  dbName: 'myapp',
+  query: 'SELECT * FROM users'
+}, successCallback, errorCallback);
+```
 
-// Delete data
-await database.delete('users', { id: 1 });
+**Features:**
+- SQLite integration
+- ORM-like interface
+- Transaction support
+- Connection pooling
+- Batch operations
+- Both callback and promise-based APIs
 
-// Execute transaction
-await database.transaction(async (db) => {
-  await db.upsert('users', userData);
-  await db.upsert('profiles', profileData);
-});
+📚 **[Database Documentation](./DATABASE_USAGE.md)** | **[Quick Reference](./DATABASE_QUICK_REF.md)**
+
+---
+
+### 3. Local Storage Module
+
+AsyncStorage wrapper with automatic JSON serialization.
+
+```typescript
+import { LocalStorage } from '@unvired/react-native-unvired-sdk';
+
+// Store data
+await LocalStorage.setItem('user', { name: 'John', age: 30 });
+
+// Retrieve data
+const user = await LocalStorage.getItem<{ name: string; age: number }>('user');
+
+// Remove item
+await LocalStorage.removeItem('user');
+
+// Clear all
+await LocalStorage.clear();
+
+// Batch operations
+await LocalStorage.multiSet([
+  ['key1', 'value1'],
+  ['key2', 'value2']
+]);
+```
+
+**Features:**
+- Automatic JSON serialization/deserialization
+- TypeScript generics support
+- Batch operations
+- Error handling
+
+📚 **[LocalStorage Documentation](./LOCALSTORAGE_USAGE.md)**
+
+---
+
+### 4. Device Info Module
 
-// Clear all data
-await database.clear();
+Device information and platform detection.
 
-// Close database
-await database.close();
+```typescript
+import { DeviceInfo } from '@unvired/react-native-unvired-sdk';
+
+// Synchronous (returns cached data)
+const deviceInfo = DeviceInfo.getDeviceInfoSync();
+console.log(deviceInfo.platform); // 'ios' or 'android'
+console.log(deviceInfo.model); // 'iPhone 14 Pro'
+console.log(deviceInfo.manufacturer); // 'Apple'
+
+// Get platform
+const platform = DeviceInfo.getPlatform(); // 'ios' or 'android'
+
+// Get frontend type
+const frontendType = DeviceInfo.getFrontendType(); // 'APPLE_PHONE' or 'ANDROID_PHONE'
+
+// Async (populates cache)
+await DeviceInfo.getDeviceInfo();
 ```
 
-### Notifications
+**Features:**
+- Platform detection
+- Device model and manufacturer
+- Unique device ID
+- App version information
+- Tablet detection
+
+---
+
+### 5. File System Module
+
+Comprehensive file system operations.
 
-```javascript
-import { notificationManager } from 'react-native-unvired-sdk';
+```typescript
+import { FileSystem } from '@unvired/react-native-unvired-sdk';
+
+// Get document directory
+const docDir = FileSystem.getDocumentDirectory();
+
+// Read/Write files
+const content = await FileSystem.readFile('/path/to/file.txt');
+await FileSystem.writeFile('/path/to/file.txt', 'content');
+
+// File operations
+await FileSystem.copyFile(source, destination);
+await FileSystem.moveFile(source, destination);
+await FileSystem.deleteFile('/path/to/file.txt');
+
+// Directory operations
+await FileSystem.createDirectory('/path/to/dir');
+const files = await FileSystem.readDir('/path/to/dir');
+
+// Check existence
+const exists = await FileSystem.exists('/path/to/file');
+
+// User-specific folders
+const userFolder = await FileSystem.getFolderBasedOnUserId('user123');
+await FileSystem.deleteUserFolder('user123');
+```
 
-// Initialize notifications (if not done in SDK initialization)
-await notificationManager.initialize({ /* config */ });
+**Features:**
+- File read/write operations
+- Directory management
+- File copy/move operations
+- User-specific folder management
+- File existence checks
+- File stats and metadata
 
-// Request permissions
-const granted = await notificationManager.requestPermissions();
+---
 
-// Show a notification
-await notificationManager.showNotification({
-  title: 'Hello',
-  body: 'This is a notification',
-  data: { customData: 'value' }
+### 6. Push Notification Module
+
+Firebase Cloud Messaging integration.
+
+```typescript
+import { PushNotification } from '@unvired/react-native-unvired-sdk';
+
+const push = new PushNotification();
+
+// Request permission
+await push.requestPermission();
+
+// Get token
+const token = await push.getToken();
+
+// Listen for token refresh
+push.onTokenRefresh((newToken) => {
+  console.log('Token refreshed:', newToken);
 });
 
-// Schedule a notification
-const notificationId = await notificationManager.scheduleNotification(
-  {
-    title: 'Reminder',
-    body: 'Don\'t forget!'
-  },
-  new Date(Date.now() + 3600000) // 1 hour from now
-);
-
-// Cancel a notification
-await notificationManager.cancelNotification(notificationId);
-
-// Listen for notification events
-const unsubscribe = notificationManager.on('onNotificationReceived', (notification) => {
-  console.log('Notification received:', notification);
+// Listen for messages
+push.onMessage((message) => {
+  console.log('Foreground message:', message);
 });
 
-// Set badge count
-await notificationManager.setBadgeCount(5);
+// Listen for background messages
+push.onBackgroundMessage((message) => {
+  console.log('Background message:', message);
+});
 
-// Get badge count
-const count = await notificationManager.getBadgeCount();
+// Subscribe to topics
+await push.subscribeToTopic('news');
+await push.unsubscribeFromTopic('news');
 ```
 
-### File System Operations
+**Features:**
+- FCM integration
+- Permission handling
+- Token management
+- Foreground/background message handling
+- Topic subscription
+- Initial notification handling
 
-```javascript
-import { fileManager } from 'react-native-unvired-sdk';
+---
 
-// Initialize file manager (if not done in SDK initialization)
-await fileManager.initialize({ basePath: '/path/to/files' });
+### 7. Platform Adapter Module
 
-// Read a file
-const content = await fileManager.readFile('data.txt');
+Unified interface for all platform-specific functionality.
 
-// Write to a file
-await fileManager.writeFile('data.txt', 'Hello World');
+```typescript
+import { getPlatformAdapter } from '@unvired/react-native-unvired-sdk';
 
-// Append to a file
-await fileManager.appendFile('log.txt', 'New log entry\n');
+const platform = getPlatformAdapter();
 
-// Check if file exists
-const exists = await fileManager.exists('data.txt');
+// Device info
+const deviceInfo = platform.getDeviceInfo();
+const platformName = platform.getPlatform();
 
-// Delete a file
-await fileManager.deleteFile('old-file.txt');
+// File system
+const docDir = platform.getDocumentDirectory();
+const userFolder = await platform.getFolderBasedOnUserId('user123');
 
-// Create directory
-await fileManager.createDirectory('my-folder');
+// Database
+const dbAdapter = platform.getDatabaseAdapter();
+
+// Storage
+const storage = platform.getStorageAdapter();
+await storage.setItem('key', 'value');
+
+// Logger
+const logger = platform.getLoggerAdapter();
+logger.logInfo('Class', 'method', 'message');
 
-// List files in directory
-const files = await fileManager.listFiles('my-folder');
+// Push notifications
+const pushAdapter = platform.getPushNotificationAdapter();
+```
+
+**Features:**
+- Unified interface for all modules
+- Consistent API across platforms
+- Easy integration with ts-core-sdk
+- Singleton pattern
+
+📚 **[Platform Adapter Documentation](./PLATFORM_USAGE.md)**
+
+---
+
+## 📖 Documentation
+
+- **[Platform Adapter Guide](./PLATFORM_USAGE.md)** - Complete platform adapter documentation
+- **[Database Guide](./DATABASE_USAGE.md)** - Database operations and examples
+- **[Database Quick Reference](./DATABASE_QUICK_REF.md)** - Quick reference for database
+- **[LocalStorage Guide](./LOCALSTORAGE_USAGE.md)** - Local storage operations
+- **[Module Connection Map](./MODULE_CONNECTION_MAP.md)** - Architecture and module connections
+- **[How to Use in ts-core-sdk](./HOW_TO_USE_IN_TS_CORE_SDK.md)** - Integration guide
+
+---
+
+## 🎯 TypeScript Support
+
+The SDK is fully typed with TypeScript:
+
+```typescript
+import type {
+  // Platform types
+  IPlatformAdapter,
+  IDeviceInfo,
+  IFileEntry,
+  
+  // Database types
+  IDatabaseAdapter,
+  DatabaseOptions,
+  
+  // Logger types
+  ILoggerAdapter,
+  LogLevel,
+  
+  // Storage types
+  IStorageAdapter,
+  
+  // Push notification types
+  IPushNotificationAdapter
+} from '@unvired/react-native-unvired-sdk';
+```
 
-// Copy file
-await fileManager.copyFile('source.txt', 'destination.txt');
+---
 
-// Move file
-await fileManager.moveFile('old-location.txt', 'new-location.txt');
+## 📋 Requirements
 
-// Download file
-await fileManager.downloadFile(
-  'https://example.com/file.pdf',
-  'downloads/file.pdf',
-  (progress) => console.log(`Downloaded: ${progress}%`)
-);
+- **React Native** >= 0.60.0
+- **React** >= 16.8.0
+- **iOS** >= 11.0
+- **Android** >= API 21
+- **Node.js** >= 14.0.0
 
-// Upload file
-await fileManager.uploadFile(
-  'local-file.jpg',
-  'https://example.com/upload',
-  { headers: { 'Authorization': 'Bearer token' } },
-  (progress) => console.log(`Uploaded: ${progress}%`)
-);
+---
 
-// Get file info
-const info = await fileManager.getFileInfo('data.txt');
-console.log(info.size, info.modifiedTime);
+## 🤝 Contributing
+
+This is a private SDK. For issues and questions, please contact Unvired support.
+
+---
+
+## 📄 License
+
+UNLICENSED - Private SDK for Unvired applications
+
+---
+
+## 🆘 Support
+
+For support and questions:
+- Check the documentation files in this repository
+- Contact Unvired support team
+
+---
+
+## 🎉 Summary
+
+The Unvired React Native SDK provides:
+
+- ✅ **7 Major Modules** - Logger, Database, LocalStorage, DeviceInfo, FileSystem, PushNotification, Platform
+- ✅ **Clean Architecture** - Modular design with consistent patterns
+- ✅ **Full TypeScript** - Complete type safety throughout
+- ✅ **Production Ready** - Battle-tested and optimized
+- ✅ **Comprehensive Docs** - Detailed guides and examples
+- ✅ **Easy Integration** - Works seamlessly with ts-core-sdk
+
+**Build powerful React Native applications with confidence!** 🚀
+
+Comprehensive SDK for React Native applications providing logging, database, storage, file system, device info, and push notification capabilities.
+
+## Features
+
+- 📝 **Logger** - Advanced logging with file persistence and compression
+- 💾 **Database** - SQLite database with ORM-like interface
+- 🗄️ **Local Storage** - AsyncStorage wrapper with JSON serialization
+- 📁 **File System** - Comprehensive file system operations
+- 📱 **Device Info** - Device information and platform detection
+- 🔔 **Push Notifications** - Firebase Cloud Messaging integration
+- 🔌 **Platform Adapter** - Unified interface for all platform-specific functionality
+
+## Installation
+
+```bash
+npm install @unvired/react-native-unvired-sdk
 ```
 
-### SDK Shutdown
+### Peer Dependencies
 
-```javascript
-// Properly shutdown SDK and cleanup resources
-await UnviredSDK.shutdown();
+Install required peer dependencies:
+
+```bash
+npm install react-native-device-info @dr.pogodin/react-native-fs react-native-sqlite-storage @react-native-async-storage/async-storage
 ```
 
-## API Reference
+### Optional Dependencies
 
-### Log Levels
-
-- `LogLevel.DEBUG` - Detailed debugging information
-- `LogLevel.INFO` - General informational messages
-- `LogLevel.WARN` - Warning messages
-- `LogLevel.ERROR` - Error messages
-- `LogLevel.NONE` - Disable all logging
-
-### Logger Methods
-
-- `logger.debug(message, ...args)` - Log debug message
-- `logger.info(message, ...args)` - Log info message
-- `logger.warn(message, ...args)` - Log warning message
-- `logger.error(message, ...args)` - Log error message
-- `logger.setLogLevel(level)` - Set minimum log level
-- `logger.setTag(tag)` - Set custom tag
-- `logger.createChild(childTag)` - Create child logger with custom tag
-
-### Database Methods
-
-- `database.initialize(config)` - Initialize database
-- `database.upsert(table, data)` - Insert or update data
-- `database.query(table, query)` - Query data
-- `database.delete(table, query)` - Delete data
-- `database.transaction(callback)` - Execute transaction
-- `database.clear()` - Clear all data
-- `database.close()` - Close database connection
-
-### Notification Methods
-
-- `notificationManager.initialize(config)` - Initialize notifications
-- `notificationManager.requestPermissions()` - Request notification permissions
-- `notificationManager.showNotification(notification)` - Show notification
-- `notificationManager.scheduleNotification(notification, time)` - Schedule notification
-- `notificationManager.cancelNotification(id)` - Cancel notification
-- `notificationManager.cancelAllNotifications()` - Cancel all notifications
-- `notificationManager.on(event, handler)` - Register event handler
-- `notificationManager.setBadgeCount(count)` - Set badge count
-- `notificationManager.getBadgeCount()` - Get badge count
-
-### File System Methods
-
-- `fileManager.initialize(config)` - Initialize file manager
-- `fileManager.readFile(path, encoding)` - Read file
-- `fileManager.writeFile(path, content, encoding)` - Write file
-- `fileManager.appendFile(path, content, encoding)` - Append to file
-- `fileManager.deleteFile(path)` - Delete file
-- `fileManager.exists(path)` - Check if file exists
-- `fileManager.createDirectory(path)` - Create directory
-- `fileManager.listFiles(path)` - List files in directory
-- `fileManager.copyFile(source, dest)` - Copy file
-- `fileManager.moveFile(source, dest)` - Move file
-- `fileManager.downloadFile(url, path, onProgress)` - Download file
-- `fileManager.uploadFile(path, url, options, onProgress)` - Upload file
-- `fileManager.getFileInfo(path)` - Get file information
-
-## Development
+For push notifications:
 
 ```bash
-# Install dependencies
-npm install
+npm install @react-native-firebase/app @react-native-firebase/messaging
+```
 
-# Run tests
-npm test
+### Platform Setup
 
-# Lint code
-npm run lint
+#### iOS
 
-# Format code
-npm run format
+```bash
+cd ios && pod install
 ```
 
-## Architecture
+#### Android
 
-The SDK is organized into modular components:
+Ensure your `android/build.gradle` has the required repositories.
 
+## Quick Start
+
+```typescript
+import {
+  getPlatformAdapter,
+  logger,
+  LocalStorage,
+  createDatabase
+} from '@unvired/react-native-unvired-sdk';
+
+// Get platform adapter (recommended)
+const platform = getPlatformAdapter();
+
+// Or use individual modules
+logger.logInfo('App', 'init', 'Application started');
+await LocalStorage.setItem('user', { name: 'John' });
+const db = createDatabase('myapp');
 ```
-src/
-├── logger/          # Logging utilities
-├── database/        # Database operations
-├── notifications/   # Notification management
-├── fileSystem/      # File system operations
-└── index.js         # Main SDK entry point
+
+## Modules
+
+### 1. Platform Adapter (Recommended)
+
+Unified interface for all SDK functionality.
+
+```typescript
+import { getPlatformAdapter } from '@unvired/react-native-unvired-sdk';
+
+const platform = getPlatformAdapter();
+
+// Device info
+const deviceInfo = platform.getDeviceInfo();
+
+// Logger
+const logger = platform.getLoggerAdapter();
+logger.logInfo('MyClass', 'myMethod', 'Message');
+
+// Database
+const dbAdapter = platform.getDatabaseAdapter();
+
+// Storage
+const storage = platform.getStorageAdapter();
+await storage.setItem('key', 'value');
+
+// File system
+const userFolder = await platform.getFolderBasedOnUserId('user123');
+
+// Push notifications
+const pushAdapter = platform.getPushNotificationAdapter();
 ```
 
-Each module can be initialized independently or as part of the main SDK initialization.
+📚 **[Platform Adapter Documentation](./PLATFORM_USAGE.md)**
+
+---
+
+### 2. Logger
+
+Advanced logging with file persistence, compression, and rotation.
+
+```typescript
+import { logger } from '@unvired/react-native-unvired-sdk';
+
+logger.setLogLevel('DEBUG');
+logger.logDebug('MyClass', 'myMethod', 'Debug message');
+logger.logInfo('MyClass', 'myMethod', 'Info message');
+logger.logError('MyClass', 'myMethod', 'Error message');
+
+// Get log file content
+const logs = await logger.getLogFileContent();
+```
+
+**Features:**
+- Multiple log levels (DEBUG, INFO, ERROR)
+- File persistence with rotation
+- Compression (gzip)
+- Async operations
+
+---
+
+### 3. Database
+
+SQLite database with both low-level and high-level APIs.
+
+```typescript
+import { createDatabase, DatabaseManager } from '@unvired/react-native-unvired-sdk';
+
+// High-level API (recommended)
+const db = createDatabase('myapp');
+
+await db.createTable('users', {
+  id: 'INTEGER PRIMARY KEY AUTOINCREMENT',
+  name: 'TEXT NOT NULL',
+  email: 'TEXT UNIQUE'
+});
+
+await db.insert('users', { name: 'John', email: 'john@example.com' });
+const users = await db.select('users');
+
+// Low-level API
+const adapter = DatabaseManager.getDatabaseAdapter();
+adapter.execute({
+  dbName: 'myapp',
+  query: 'SELECT * FROM users'
+}, successCallback, errorCallback);
+```
+
+**Features:**
+- SQLite integration
+- ORM-like interface
+- Transaction support
+- Connection pooling
+- Batch operations
+
+📚 **[Database Documentation](./DATABASE_USAGE.md)** | **[Quick Reference](./DATABASE_QUICK_REF.md)**
+
+---
+
+### 4. Local Storage
+
+AsyncStorage wrapper with automatic JSON serialization.
+
+```typescript
+import { LocalStorage } from '@unvired/react-native-unvired-sdk';
+
+// Store data
+await LocalStorage.setItem('user', { name: 'John', age: 30 });
+
+// Retrieve data
+const user = await LocalStorage.getItem<{ name: string; age: number }>('user');
+
+// Remove item
+await LocalStorage.removeItem('user');
+
+// Clear all
+await LocalStorage.clear();
+
+// Batch operations
+await LocalStorage.multiSet([
+  ['key1', 'value1'],
+  ['key2', 'value2']
+]);
+```
+
+**Features:**
+- Automatic JSON serialization/deserialization
+- TypeScript generics support
+- Batch operations
+- Error handling
+
+📚 **[LocalStorage Documentation](./LOCALSTORAGE_USAGE.md)**
+
+---
+
+### 5. File System
+
+Comprehensive file system operations.
+
+```typescript
+import { FileSystemManager } from '@unvired/react-native-unvired-sdk';
+
+// Create directory
+await FileSystemManager.createDirectory('/path/to/dir');
+
+// Read/Write files
+const content = await FileSystemManager.readFile('/path/to/file.txt');
+await FileSystemManager.writeFile('/path/to/file.txt', 'content');
+
+// File operations
+await FileSystemManager.copyFile(source, destination);
+await FileSystemManager.moveFile(source, destination);
+await FileSystemManager.deleteFile('/path/to/file.txt');
+
+// Check existence
+const exists = await FileSystemManager.exists('/path/to/file.txt');
+
+// List directory
+const files = await FileSystemManager.readDir('/path/to/dir');
+```
+
+---
+
+### 6. Device Info
+
+Device information and platform detection.
+
+```typescript
+import { DeviceInfoManager } from '@unvired/react-native-unvired-sdk';
+
+const deviceInfo = await DeviceInfoManager.getDeviceInfo();
+console.log(deviceInfo.platform); // 'ios' or 'android'
+console.log(deviceInfo.model); // 'iPhone 14 Pro'
+console.log(deviceInfo.manufacturer); // 'Apple'
+console.log(deviceInfo.uuid); // Unique device ID
+
+const isTablet = await DeviceInfoManager.isTablet();
+const appVersion = await DeviceInfoManager.getAppVersion();
+```
+
+---
+
+### 7. Push Notifications
+
+Firebase Cloud Messaging integration.
+
+```typescript
+import { PushNotificationManager } from '@unvired/react-native-unvired-sdk';
+
+const pushManager = new PushNotificationManager();
+
+// Request permission
+await pushManager.requestPermission();
+
+// Get token
+const token = await pushManager.getToken();
+
+// Listen for messages
+pushManager.onMessage((message) => {
+  console.log('Foreground message:', message);
+});
+
+pushManager.onBackgroundMessage((message) => {
+  console.log('Background message:', message);
+});
+
+// Subscribe to topics
+await pushManager.subscribeToTopic('news');
+```
+
+---
+
+## TypeScript Support
+
+The SDK is fully typed with TypeScript:
+
+```typescript
+import type {
+  PlatformInterface,
+  IDeviceInfo,
+  IFileEntry,
+  IDatabaseAdapter,
+  IPushNotificationAdapter,
+  ILoggerAdapter,
+  IStorageAdapter,
+  LogLevel
+} from '@unvired/react-native-unvired-sdk';
+```
+
+---
+
+## Complete Example
+
+```typescript
+import React, { useEffect } from 'react';
+import { View, Text } from 'react-native';
+import {
+  getPlatformAdapter,
+  createDatabase,
+  LocalStorage,
+  logger
+} from '@unvired/react-native-unvired-sdk';
+
+const App = () => {
+  useEffect(() => {
+    initializeSDK();
+  }, []);
+
+  const initializeSDK = async () => {
+    // Initialize logger
+    logger.setLogLevel('DEBUG');
+    logger.logInfo('App', 'init', 'Initializing SDK');
+
+    // Get platform adapter
+    const platform = getPlatformAdapter();
+    const deviceInfo = platform.getDeviceInfo();
+    logger.logInfo('App', 'init', `Platform: ${deviceInfo.platform}`);
+
+    // Initialize database
+    const db = createDatabase('myapp');
+    await db.createTable('users', {
+      id: 'INTEGER PRIMARY KEY AUTOINCREMENT',
+      name: 'TEXT NOT NULL',
+      email: 'TEXT UNIQUE'
+    });
+
+    // Store user preferences
+    await LocalStorage.setItem('preferences', {
+      theme: 'dark',
+      notifications: true
+    });
+
+    // Get user folder
+    const userFolder = await platform.getFolderBasedOnUserId('user123');
+    logger.logInfo('App', 'init', `User folder: ${userFolder}`);
+
+    // Initialize push notifications
+    const pushAdapter = platform.getPushNotificationAdapter();
+    if (pushAdapter) {
+      await pushAdapter.requestPermission();
+      const token = await pushAdapter.getToken();
+      logger.logInfo('App', 'init', `FCM Token: ${token}`);
+    }
+  };
+
+  return (
+    <View>
+      <Text>Unvired SDK Initialized</Text>
+    </View>
+  );
+};
+
+export default App;
+```
+
+---
+
+## Documentation
+
+- **[Platform Adapter Guide](./PLATFORM_USAGE.md)** - Complete platform adapter documentation
+- **[Database Guide](./DATABASE_USAGE.md)** - Database operations and examples
+- **[Database Quick Reference](./DATABASE_QUICK_REF.md)** - Quick reference for database
+- **[LocalStorage Guide](./LOCALSTORAGE_USAGE.md)** - Local storage operations
+
+---
+
+## API Reference
+
+### Exports
+
+```typescript
+// Platform
+export { ReactNativePlatformAdapter, getPlatformAdapter, resetPlatformAdapter }
+export { DeviceInfoManager, FileSystemManager, PushNotificationManager }
+
+// Logger
+export { Logger, logger }
+
+// Database
+export { DatabaseManager, Database, createDatabase }
+
+// Storage
+export { LocalStorage }
+
+// Types
+export type {
+  PlatformInterface,
+  IDeviceInfo,
+  IFileEntry,
+  IDatabaseAdapter,
+  IPushNotificationAdapter,
+  ILoggerAdapter,
+  IStorageAdapter,
+  LogLevel,
+  DatabaseOptions,
+  // ... and more
+}
+```
+
+---
+
+## Best Practices
+
+1. **Use Platform Adapter** - Recommended for accessing all SDK functionality
+2. **Initialize Early** - Initialize SDK in your app's entry point
+3. **Handle Errors** - Always use try-catch for async operations
+4. **TypeScript** - Leverage TypeScript for type safety
+5. **Logging** - Use the logger for consistent logging across your app
+6. **Clean Up** - Properly close database connections and clean up resources
+
+---
+
+## Requirements
+
+- React Native >= 0.60.0
+- React >= 16.8.0
+- iOS >= 11.0
+- Android >= API 21
+
+---
 
 ## License
 
-MIT
+UNLICENSED
+
+---
+
+## Support
+
+For issues and questions, please refer to the documentation files or contact Unvired support.