@sency/react-native-smkit-ui 2.0.1 → 2.0.3

package/README.md

@@ -1,113 +1,138 @@
-# [Github:](https://github.com/sency-ai/smkit-sdk)
+# React Native SMKit UI Library
 
-1. [ Installation ](#inst)
-2. [ Setup ](#setup)
-3. [ API ](#api)
-4. [ Data ](#data)
+AI-powered fitness assessments, custom workouts, and workout programs with real-time motion detection for React Native apps.
 
-<a name="inst"></a>
+## Table of Contents
 
-## 1. Installation
+1. [Features](#features)
+2. [Requirements](#requirements)
+3. [Installation](#installation)
+4. [Platform Setup](#platform-setup)
+5. [Getting Started](#getting-started)
+6. [Core Features](#core-features)
+7. [API Reference](#api-reference)
+8. [Examples](#examples)
+9. [Troubleshooting](#troubleshooting)
+10. [Support](#support)
 
-run `npm install @sency/react-native-smkit-ui`
+---
 
-## 2. Setup <a name="setup"></a>
+## Features
 
-# iOS Setup
+- **Fitness Assessments** - AI-driven fitness evaluations tailored to user fitness levels
+- **Workout Programs** - Multi-week customizable workout plans with progression tracking
+- **Motion Detection** - Real-time motion capture and analysis with pose detection
+- **Multiple Assessment Types** - Fitness, Body360, Strength, Cardio, and custom assessments
+- **Cross-Platform** - Native support for iOS and Android
+- **Configurable Workouts** - Customize by body zone, difficulty, and duration
 
-1. Update _Podfile_ in `iOS` folder:
+---
 
-```
-[1] add the source to the top of your Podfile.
-source 'https://bitbucket.org/sencyai/ios_sdks_release.git'
-source 'https://github.com/CocoaPods/Specs.git'
+## Requirements
 
-[2] add use_frameworks! commend to your target
-target 'YOUR_TARGET' do
-  use_frameworks!
+### General
+- **Node.js** 18+
+- **npm** or **yarn**
 
-[3] At the end of your code please add
-
-  post_install do |installer|
-   react_native_post_install(
-     installer,
-     :mac_catalyst_enabled => false
-   )
-   installer.pods_project.targets.each do |target|
-     target.build_configurations.each do |config|
-       config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
-       config.build_settings['EXCLUDED_ARCHS[sdk=iphonesimulator*]'] = 'arm64'
-     end
-   end
-   __apply_Xcode_12_5_M1_post_install_workaround(installer)
- end
-end
+### iOS
+- **iOS 13+**
+- **Xcode 14+**
+- **CocoaPods**
+
+### Android
+- **Android API 26+**
+- **Android Studio** with SDK tools
+- **JDK 11+**
+
+---
+
+## Installation
 
+Install the package via npm:
+
+```bash
+npm install @sency/react-native-smkit-ui
 ```
 
-2. Run `NO_FLIPPER=1 pod install` to install the necessary pods.
-3. Add camera permission request to `Info.plist`
+Or with yarn:
 
-```Xml
-<key>NSCameraUsageDescription</key>
-<string>Camera access is needed</string>
+```bash
+yarn add @sency/react-native-smkit-ui
+```
+
+Then install native dependencies:
+
+```bash
+cd ios && pod install && cd ..
 ```
 
 ---
 
-## Known issues
+## Platform Setup
+
+### iOS Setup
 
-1. Dynamic/Static linking issues due to `use_frameworks`:
-   If you're unable to use use_frameworks you should add the following code to your Podfile:
+1. Add the required CocoaPods sources to your `ios/Podfile`:
 
 ```ruby
-# [1] Add the dynamic_frameworks array that will hold all of the dynamic frameworks names
-dynamic_frameworks = ['SMKitUI', 'SMKit', 'SMBase', 'SwiftyJSON', 'SMBaseUI']
-
-# [2] Add this pre_install function
-pre_install do |installer|
-  installer.pod_targets.each do |pod|
-    if dynamic_frameworks.include?(pod.name)
-      def pod.build_type
-        Pod::BuildType.dynamic_framework
-      end
-    end
-  end
+source 'https://bitbucket.org/sencyai/ios_sdks_release.git'
+source 'https://github.com/CocoaPods/Specs.git'
+```
+
+2. Add `use_frameworks!` to your target:
+
+```ruby
+target 'YourApp' do
+  use_frameworks!
+  # ... other pods
 end
+```
+
+3. Add the post-install hook at the end of your Podfile:
 
-# [3] Add this post_install function
+```ruby
 post_install do |installer|
-react_native_post_install(installer, config[:reactNativePath], :mac_catalyst_enabled => false)
-   installer.pods_project.targets.each do |target|
-    if dynamic_frameworks.include?(target.name)
-        target.build_configurations.each do |config|
-          config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
-          config.build_settings['EXCLUDED_ARCHS[sdk=iphonesimulator*]'] = 'arm64'
-        end
-      end
+  react_native_post_install(
+    installer,
+    :mac_catalyst_enabled => false
+  )
+  installer.pods_project.targets.each do |target|
+    target.build_configurations.each do |config|
+      config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
+      config.build_settings['EXCLUDED_ARCHS[sdk=iphonesimulator*]'] = 'arm64'
     end
   end
+  __apply_Xcode_12_5_M1_post_install_workaround(installer)
 end
 ```
 
-Now you can run pod install.
+4. Install pods:
+
+```bash
+cd ios
+NO_FLIPPER=1 pod install
+cd ..
+```
+
+5. Add camera permission to `Info.plist`:
 
-# Android Setup
+```xml
+<key>NSCameraUsageDescription</key>
+<string>Camera access is needed for fitness assessments and motion detection</string>
+```
 
-In order to integrate SMKitUI you need your app to target minSdk 26
-Add on project level `build.gradle`:
+### Android Setup
 
-```groovy
+1. Update your project-level `build.gradle`:
+
+```gradle
 buildscript {
     ext {
         minSdkVersion = 26
+        // ... other settings
     }
 }
-```
-
-Add on project level build.gradle:
 
-```groovy
 allprojects {
     maven {
         url "https://artifacts.sency.ai/artifactory/release/"
@@ -115,558 +140,376 @@ allprojects {
 }
 ```
 
-## 3. API<a name="api"></a>
-
-### 1. Configure <a name="conf"></a>
+2. Ensure your app's `build.gradle` targets Android API 26+:
 
-```js
-[1] First import configure
-import { configure } from '@sency/react-native-smkit-ui/src/index.tsx';
-
-[2] then call the configure function with your auth key
-try{
-  var res = await configure("YOUR_AUTH_KEY");
- }catch (e) {
-  console.error(e);
+```gradle
+android {
+    compileSdkVersion 35
+    defaultConfig {
+        minSdkVersion 26
+        targetSdkVersion 35
+    }
 }
 ```
 
-To reduce wait time we recommend to call `configure` on app launch.
-
-**⚠️ smkit_ui_library will not work if you don't first call configure.**
-
-## 2. Start <a name="start"></a>
-
-#### [Start Assessment](#data)
-
-- [Start Assessment](https://github.com/sency-ai/smkit-ui-react-native-demo/blob/main/Assessment.md)
-
-- [Start Workout](https://github.com/sency-ai/smkit-ui-react-native-demo/blob/main/Workout.md)
-
-- [Build Your Own Assessment](https://github.com/sency-ai/smkit-ui-react-native-demo/blob/main/CustomizedAssessment.md)
-
-##Data <a name="data"></a>
-
-### AssessmentTypes
-
-| Name (enum) | Description                                                                                                                                                                    | More info                                                                                    |
-| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------- |
-| Fitness     | For individuals of any activity level who seek to enhance their physical abilities, strength, and endurance through a tailored plan.                                           | [Link](https://github.com/sency-ai/smkit-sdk/blob/main/Assessments/AI-Fitness-Assessment.md) |
-| Body360     | Designed for individuals of any age and activity level, this assessment determines the need for a preventative plan or medical support.                                        | [Link](https://github.com/sency-ai/smkit-sdk/blob/main/Assessments/360-Body-Assessment.md)   |
-| Strength    | For individuals of any activity level who seek to assess their strength capabilities (core and endurance) \* This assessment will be available soon. Contact us for more info. | [Link](https://github.com/sency-ai/smkit-sdk/blob/main/Assessments/Strength.md)              |
-| Cardio      | For individuals of any activity level who seek to assess their cardiovascular capabilities \* This assessment will be available soon. Contact us for more info.                | [Link](https://github.com/sency-ai/smkit-sdk/blob/main/Assessments/Cardio.md)                |
-| Custom      | If Sency created a tailored assessment for you, you probably know it, and you should use this enum.                                                                            |                                                                                              |
-
-Having issues? [Contact us](mailto:support@sency.ai) and let us know what the problem is.
-
-# React Native SMKit UI Library
-
-This is a React Native plugin that implements the SMKit UI native library for both iOS and Android platforms. The library provides fitness assessments, custom workouts, and workout programs with motion detection capabilities.
-
-## Prerequisites
-
-Before running the example app, ensure you have the following installed:
-
-### General Requirements
-- **Node.js** (version 18 or higher)
-- **Yarn** package manager
-- **React Native CLI**
-
-### iOS Development
-- **Xcode** (latest version)
-- **CocoaPods**
-- **iOS Simulator** or physical iOS device
+---
 
-### Android Development
-- **Android Studio** with Android SDK
-- **Java Development Kit (JDK)** 11 or higher
-- **Android Virtual Device (AVD)** or physical Android device
+## Getting Started
 
-## Quick Setup Guide
+### 1. Initialize the Library
 
-### 1. Install Dependencies
+Call `configure()` as early as possible in your app (e.g., on app launch):
 
-First, install Yarn globally if you haven't already:
-```bash
-npm install -g yarn
-```
+```typescript
+import { configure } from '@sency/react-native-smkit-ui';
 
-Install React Native CLI:
-```bash
-npm install -g @react-native-community/cli
+try {
+  await configure('YOUR_API_KEY');
+} catch (error) {
+  console.error('Failed to configure SMKit UI:', error);
+}
 ```
 
-### 2. Clone and Setup Project
-
-```bash
-# Navigate to the project root
-cd /path/to/react-native-smkit-ui
-
-# Install root dependencies
-yarn install
-
-# Build the library
-yarn build
-```
+> **⚠️ Important:** The library will not function until `configure()` is called successfully.
 
-### 3. Setup Example App
+### 2. Request Camera Permissions
 
-```bash
-# Create the library package
-npm pack
+Ensure your app has camera permissions granted before starting assessments or workouts:
 
-# Navigate to example directory
-cd example
+```typescript
+import { request, PERMISSIONS, RESULTS } from 'react-native-permissions';
 
-# Update package.json to use the generated tarball
-# The tarball will be named something like: sency-react-native-smkit-ui-1.3.2.tgz
-```
+const cameraPermission = await request(
+  Platform.OS === 'ios' 
+    ? PERMISSIONS.IOS.CAMERA 
+    : PERMISSIONS.ANDROID.CAMERA
+);
 
-Update `example/package.json` dependencies:
-```json
-{
-  "dependencies": {
-    "@sency/react-native-smkit-ui": "file:../sency-react-native-smkit-ui-1.3.2.tgz",
-    // ... other dependencies
-  }
+if (cameraPermission === RESULTS.GRANTED) {
+  // Ready to start assessments/workouts
 }
 ```
 
-```bash
-# Install example dependencies
-yarn install
-```
+---
 
-## Running on iOS
+## Core Features
 
-### 1. Install iOS Dependencies
-```bash
-cd example/ios
-pod install
-cd ..
-```
+### Assessment Types
 
-### 2. Start Metro Bundler
-```bash
-yarn start
-```
+| Type | Purpose | Use Case |
+|------|---------|----------|
+| **Fitness** | Comprehensive fitness evaluation | General fitness assessment for all levels |
+| **Body360** | Full-body movement and posture analysis | Preventative health screening |
+| **Strength** | Core and endurance strength testing | Evaluate strength capabilities |
+| **Cardio** | Cardiovascular capacity assessment | Assess aerobic fitness |
+| **Custom** | Custom assessment (provided by Sency) | Specialized evaluations |
 
-### 3. Run iOS App
-In a new terminal:
-```bash
-cd example
-yarn ios
-```
+### Workout Configuration
 
-Or to run on a specific simulator:
-```bash
-yarn ios --simulator="iPhone 15"
-```
+Customize workouts with:
+- **Body Zones**: Full Body, Upper Body, Lower Body, Core
+- **Difficulty**: Low, Medium, High
+- **Duration**: Short, Medium, Long
+- **Week Number**: For multi-week programs
 
-## Running on Android
+---
 
-### 1. Setup Android Environment
+## API Reference
 
-Make sure you have:
-- Android Studio installed with Android SDK
-- Android Virtual Device (AVD) created and running, OR
-- Physical Android device connected with USB debugging enabled
+### Core Methods
 
-Check your setup:
-```bash
-npx react-native doctor
-```
+#### `configure(apiKey: string): Promise<void>`
 
-### 2. Configure Gradle Memory
+Initialize the SMKit UI library with your API key.
 
-The `example/android/gradle.properties` file should include:
-```properties
-org.gradle.jvmargs=-Xmx4096m -XX:MaxMetaspaceSize=512m -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8
-org.gradle.parallel=true
-android.useAndroidX=true
-android.enableJetifier=true
-hermesEnabled=true
-```
+```typescript
+import { configure } from '@sency/react-native-smkit-ui';
 
-### 3. Start Metro Bundler
-```bash
-cd example
-yarn start
+await configure('YOUR_API_KEY');
 ```
 
-### 4. Run Android App
-In a new terminal:
-```bash
-cd example
-yarn android
-```
-
-## Troubleshooting
-
-### Metro Port Already in Use
-If you get "EADDRINUSE: address already in use :::8081":
-```bash
-# Kill existing Metro process
-lsof -ti:8081 | xargs kill -9
+---
 
-# Then restart
-yarn start --reset-cache
-```
+#### `startAssessment(type: AssessmentType, options?: AssessmentOptions): Promise<AssessmentResult>`
 
-### Android Build Issues
+Start a fitness assessment.
 
-#### Java Heap Space Error
-If you get "Java heap space" error:
-```bash
-# Clean build cache
-cd example/android
-./gradlew clean
-cd ..
-
-# Clear Gradle cache
-rm -rf ~/.gradle/caches/
+```typescript
+import { startAssessment, AssessmentType } from '@sency/react-native-smkit-ui';
 
-# Try building with specific architecture
-yarn android --variant=debug --architectures=arm64-v8a
+const result = await startAssessment(AssessmentType.Fitness, {
+  showSummary: true,
+  customId: 'user-123'
+});
 ```
 
-#### Dependency Resolution Issues
-```bash
-# Clear all caches and reinstall
-cd example
-rm -rf node_modules
-yarn install
-
-# Reset Metro cache
-yarn start --reset-cache
-```
+**Parameters:**
+- `type` - The assessment type (Fitness, Body360, Strength, Cardio, Custom)
+- `options` - Optional configuration object
+  - `showSummary` - Display summary after completion (default: true)
+  - `customId` - Custom identifier for the assessment
 
-### iOS Build Issues
+---
 
-#### Pod Installation Problems
-```bash
-cd example/ios
-rm -rf Pods
-rm Podfile.lock
-pod cache clean --all
-pod install
-cd ..
-```
+#### `startWorkoutProgram(config: WorkoutConfig): Promise<WorkoutResult>`
 
-#### Xcode Build Errors
-- Open `example/ios/SmkitUiLibraryExample.xcworkspace` in Xcode
-- Clean Build Folder (⌘ + Shift + K)
-- Build the project (⌘ + B)
-
-## Example App Features
-
-The example app demonstrates the following SMKit UI library features:
-
-### Fitness Assessments
-- **Basic Assessment**: Standard fitness evaluation
-- **Body360 Assessment**: Comprehensive body analysis
-- **Custom Assessments**: Configurable assessment types
-
-### Workouts
-- **Custom Workouts**: Create personalized exercise routines
-- **Workout Programs**: Multi-week fitness programs
-- **Exercise Types**: Squats, push-ups, lunges, planks, and more
-
-### Configuration Options
-- Body zones (Full Body, Upper Body, Lower Body, Core)
-- Difficulty levels (Low, Medium, High)
-- Duration settings (Short, Medium, Long)
-- Motion detection capabilities
-
-## Development Workflow
-
-### Making Changes to the Library
-
-1. Make your changes in the `src/` directory
-2. Build the library:
-   ```bash
-   yarn build
-   ```
-3. Create new package:
-   ```bash
-   npm pack
-   ```
-4. Update example app dependency and reinstall:
-   ```bash
-   cd example
-   yarn install
-   ```
-5. Test your changes:
-   ```bash
-   yarn ios  # or yarn android
-   ```
-
-### Testing on Physical Devices
-
-#### iOS
-- Connect your iOS device
-- Ensure it's registered in your Apple Developer account
-- Run: `yarn ios --device`
-
-#### Android
-- Enable Developer Options and USB Debugging on your device
-- Connect via USB
-- Verify connection: `adb devices`
-- Run: `yarn android`
-
-## API Usage
-
-The example app in `example/src/App.tsx` shows how to use the main library functions:
+Start a workout program with customization options.
 
 ```typescript
-import { configure, startAssessment, startCustomAssessment, startWorkoutProgram } from '@sency/react-native-smkit-ui';
-
-// Configure the library
-await configure(apiKey, userId);
-
-// Start an assessment
-await startAssessment(assessmentType, showSummary, customId);
-
-// Start a workout program
-const config = new WorkoutConfig(week, bodyZone, difficulty, duration, programId);
-await startWorkoutProgram(config);
-```
-
-## Updating Native Dependencies
+import { startWorkoutProgram, WorkoutConfig, BodyZone, Difficulty, Duration } from '@sency/react-native-smkit-ui';
 
-If you update the native SMKit UI library version (e.g., from `smkitui:1.3.6` to `smkitui:1.3.7`):
+const config = new WorkoutConfig(
+  week: 1,
+  bodyZone: BodyZone.FullBody,
+  difficulty: Difficulty.Medium,
+  duration: Duration.Medium,
+  programId: 'program-123'
+);
 
-### 1. Update Plugin Dependencies
-
-Update the version in the plugin's `android/build.gradle`:
-```gradle
-dependencies {
-    implementation 'com.sency.smkitui:smkitui:1.3.7'  // Updated version
-    // ...other dependencies
-}
+const result = await startWorkoutProgram(config);
 ```
 
-### 2. Rebuild Plugin Package
-
-```bash
-# From plugin root directory
-npm pack
-```
-
-### 3. Update Example App
-
-```bash
-cd example
-
-# Clean and reinstall dependencies
-rm -rf node_modules
-yarn install
+---
 
-# Clean Android build cache
-cd android
-./gradlew clean --refresh-dependencies
-cd ..
+#### `startCustomAssessment(config: CustomAssessmentConfig): Promise<AssessmentResult>`
 
-# Clear React Native cache and rebuild
-yarn start --reset-cache &
-yarn android
-```
+Start a custom assessment (assessment configured by Sency for your specific needs).
 
-### 4. Verify Native Dependency Update
+```typescript
+import { startCustomAssessment } from '@sency/react-native-smkit-ui';
 
-```bash
-cd example/android
-./gradlew app:dependencies | grep smkitui
-# Should show: com.sency.smkitui:smkitui:1.3.7
+const result = await startCustomAssessment({
+  customId: 'assessment-123',
+  showSummary: true
+});
 ```
 
-### 5. Troubleshoot Missing Dependencies
-
-If you get "Could not read script" errors:
-
-#### For react-native-config Issues:
-```bash
-cd example
+---
 
-# Reinstall react-native-config
-yarn remove react-native-config
-yarn add react-native-config
+## Examples
 
-# If still missing, temporarily comment out in app/build.gradle:
-# // apply from: "../../node_modules/react-native-config/android/dotenv.gradle"
+### Complete Setup Example
 
-# Use hardcoded API key temporarily in App.tsx for testing
+```typescript
+import React, { useEffect, useState } from 'react';
+import { View, TouchableOpacity, Text } from 'react-native';
+import {
+  configure,
+  startAssessment,
+  startWorkoutProgram,
+  AssessmentType,
+  BodyZone,
+  Difficulty,
+  Duration,
+  WorkoutConfig
+} from '@sency/react-native-smkit-ui';
+
+export default function FitnessApp() {
+  const [isConfigured, setIsConfigured] = useState(false);
+
+  useEffect(() => {
+    initializeApp();
+  }, []);
+
+  const initializeApp = async () => {
+    try {
+      await configure('YOUR_API_KEY');
+      setIsConfigured(true);
+    } catch (error) {
+      console.error('Configuration failed:', error);
+    }
+  };
+
+  const handleFitnessAssessment = async () => {
+    try {
+      const result = await startAssessment(AssessmentType.Fitness, {
+        showSummary: true
+      });
+      console.log('Assessment completed:', result);
+    } catch (error) {
+      console.error('Assessment failed:', error);
+    }
+  };
+
+  const handleWorkout = async () => {
+    try {
+      const config = new WorkoutConfig(
+        1,
+        BodyZone.FullBody,
+        Difficulty.Medium,
+        Duration.Medium
+      );
+      const result = await startWorkoutProgram(config);
+      console.log('Workout completed:', result);
+    } catch (error) {
+      console.error('Workout failed:', error);
+    }
+  };
+
+  return (
+    <View style={{ flex: 1, justifyContent: 'center', alignItems: 'center' }}>
+      <TouchableOpacity
+        onPress={handleFitnessAssessment}
+        disabled={!isConfigured}
+      >
+        <Text>Start Fitness Assessment</Text>
+      </TouchableOpacity>
+
+      <TouchableOpacity
+        onPress={handleWorkout}
+        disabled={!isConfigured}
+      >
+        <Text>Start Workout</Text>
+      </TouchableOpacity>
+    </View>
+  );
+}
 ```
 
-#### Force Clean All Caches:
-```bash
-# Clean gradle caches
-rm -rf ~/.gradle/caches/modules-2/files-2.1/com.sency.smkitui/
+### Body360 Assessment Example
 
-# Clean project
-cd example/android
-./gradlew clean --refresh-dependencies
-cd ..
-
-# Clean React Native
-yarn start --reset-cache
+```typescript
+const startBody360Assessment = async () => {
+  try {
+    const result = await startAssessment(AssessmentType.Body360, {
+      showSummary: true,
+      customId: `user-${Date.now()}`
+    });
+    
+    if (result.success) {
+      console.log('Body360 assessment completed');
+      console.log('Results:', result.data);
+    }
+  } catch (error) {
+    console.error('Body360 assessment error:', error);
+  }
+};
 ```
 
-## Android 15 Support
-
-The example app supports Android 15 (API level 35) with the following configuration:
+### Customized Workout Example
 
-### Requirements
-- compileSdkVersion = 35
-- targetSdkVersion = 35
-- Android Studio with Android 15 SDK
-- Gradle 8.4+
-
-### Configuration
-The project is already configured for Android 15 in `example/android/build.gradle`:
-```gradle
-buildscript {
-    ext {
-        compileSdkVersion = 35 
-        targetSdkVersion = 35   
-        kotlinVersion = "1.9.10"  
-    }
-}
+```typescript
+const startCustomizedWorkout = async () => {
+  try {
+    const config = new WorkoutConfig(
+      week: 2,
+      bodyZone: BodyZone.UpperBody,
+      difficulty: Difficulty.High,
+      duration: Duration.Long
+    );
+    
+    const result = await startWorkoutProgram(config);
+    console.log('Workout program completed:', result);
+  } catch (error) {
+    console.error('Workout error:', error);
+  }
+};
 ```
 
-### Testing on Android 15
-1. Create an Android 15 emulator in Android Studio
-2. Ensure camera permissions are granted
-3. Monitor for privacy-related warnings in logcat
+---
 
-## Environment Variables
+## Troubleshooting
 
-The example app uses environment variables to manage the SMKit API key securely:
+### "Configuration Failed" Error
 
-### Setup
-1. Copy `.env.example` to `.env` in the `example` directory
-2. Add your API key: `SMKIT_API_KEY=your_actual_key`
-3. The `.env` file is automatically ignored by git
+**Problem:** `configure()` throws an error or returns false.
 
-### Usage
-```typescript
-import Config from 'react-native-config';
+**Solutions:**
+- Verify your API key is correct
+- Check your internet connection
+- Ensure the SMKit backend service is available
+- Call `configure()` before using any other library functions
 
-const apiKey = Config.SMKIT_API_KEY;
-await configure(apiKey);
-```
+### Camera Permissions Not Granted
 
-### Troubleshooting Environment Variables
-If you get "Missing API Key" errors:
-1. Verify `.env` file exists in `example/` directory
-2. Check `SMKIT_API_KEY` is set correctly
-3. Clean and rebuild: `yarn start --reset-cache`
-4. For testing, you can temporarily use a hardcoded key
+**Problem:** Assessment or workout fails with camera permission error.
 
-## Publishing the Package
+**Solutions:**
+- Request camera permissions before starting assessments
+- Check that permissions are granted in device settings
+- On iOS, verify `NSCameraUsageDescription` is in `Info.plist`
+- On Android, ensure runtime permissions are requested
 
-### Automated Publishing with Script
+### iOS Pod Installation Issues
 
-The project includes an automated publish script that handles the entire release process:
+**Problem:** `pod install` fails or shows version conflicts.
 
+**Solutions:**
 ```bash
-# Run the interactive publish script
-npm run publish-package
-
-# Or run directly
-./scripts/publish.sh
+cd ios
+rm -rf Pods
+rm Podfile.lock
+pod cache clean --all
+pod install
+cd ..
 ```
 
-#### Publish Script Features
-
-The publish script (`scripts/publish.sh`) provides:
-
-- ✅ **Git Status Check** - Warns about uncommitted changes
-- ✅ **Version Management** - Interactive version selection (patch/minor/major/custom)
-- ✅ **Build Verification** - Cleans and builds with Bob
-- ✅ **Testing Support** - Creates test package for example app validation
-- ✅ **NPM Authentication** - Checks login status and prompts if needed
-- ✅ **Dry Run** - Shows package contents before publishing
-- ✅ **Safety Confirmations** - Multiple confirmation steps
-- ✅ **Automated Publishing** - Publishes to NPM with proper access
-- ✅ **Changelog Reminder** - Prompts to update CHANGELOG.md with release notes
-- ✅ **Git Tagging** - Creates and pushes release tags automatically
-- ✅ **Verification** - Confirms package availability on NPM
+### Android Build Failures
 
-#### Quick Commands
+**Problem:** Gradle build fails with native dependency errors.
 
+**Solutions:**
 ```bash
-# Check current versions across all files
-npm run version-check
+# Clean Gradle caches
+rm -rf ~/.gradle/caches/
 
-# Create a test package for local testing
-npm run test-package
+# Clean project
+cd android
+./gradlew clean
+cd ..
 
-# Full publish process
-npm run publish-package
+# Rebuild
+npm install
+yarn android
 ```
 
-#### Manual Publishing Steps
+### Motion Detection Not Working
 
-If you prefer manual control:
+**Problem:** Assessment starts but motion detection fails.
 
-```bash
-# 1. Update version
-npm version patch  # or minor/major
-
-# 2. Build the library
-npm run clean
-npx bob build
+**Solutions:**
+- Ensure adequate lighting in the environment
+- Position user fully in camera frame
+- Verify camera lens is clean
+- Check that device camera is not in use by another app
 
-# 3. Test with example app
-npm pack
-# Update example/package.json to use the .tgz file
-# Test the example app
+### Library Not Initializing
 
-# 4. Publish to NPM
-npm login
-npm publish --access public
+**Problem:** Features don't work even after calling `configure()`.
 
-# 5. Create git tag
-git tag v1.3.2
-git push origin v1.3.2
-```
+**Solutions:**
+- Verify `configure()` was called and completed successfully
+- Check for error messages in console logs
+- Ensure you're not calling library methods before `configure()` completes
+- Test with a fresh app start
 
-#### Pre-Publishing Checklist
-
-Before publishing, ensure:
-
-- ✅ Native dependencies are updated (e.g., `smkitui:1.3.7`)
-- ✅ Version numbers are consistent across all files
-- ✅ CHANGELOG.md is updated with release notes
-- ✅ Library builds successfully with `npx bob build`
-- ✅ Example app works with the new build
-- ✅ All changes are committed to git
-- ✅ You have NPM publish permissions for `@sency/react-native-smkit-ui`
+---
 
-## 📚 Documentation
+## Additional Resources
 
-- **[API Reference](API.md)** - Complete API documentation with examples
+- **[API Documentation](API.md)** - Complete API reference with detailed parameters
 - **[Changelog](CHANGELOG.md)** - Version history and release notes
-- **[Example App](example/)** - Working example implementation
+- **[Example App](example/)** - Working demonstration app with source code
 
-## 📦 Package Information
-
-Visit our [NPM page](https://www.npmjs.com/package/@sency/react-native-smkit-ui) for:
-- Latest version information
-- Download statistics  
-- Dependency information
-- Version history
+---
 
 ## Support
 
-For issues and questions:
-1. Check the troubleshooting sections above
-2. Run `npx react-native doctor` to verify your environment
-3. Check the example app implementation in `example/src/App.tsx`
-4. Review the native iOS and Android implementations in the respective platform folders
-5. Consult the [API Reference](API.md) for detailed function documentation
+Need help?
+
+- **Documentation**: See [API.md](API.md) for detailed API documentation
+- **Issues**: Check our [GitHub Issues](https://github.com/sency-ai/smkit-sdk/issues)
+- **Email**: [support@sency.ai](mailto:support@sency.ai)
+
+---
 
 ## License
 
 MIT
+
+---
+
+## Repository
+
+- **GitHub**: [sency-ai/smkit-sdk](https://github.com/sency-ai/smkit-sdk)
+- **NPM Package**: [@sency/react-native-smkit-ui](https://www.npmjs.com/package/@sency/react-native-smkit-ui)