Update README.md

README.md

@@ -50,32 +50,48 @@ Cactus is a lightweight, high-performance framework for running AI models on mob
     ```bash
     flutter pub get
     ```
-3. **Basic Flutter Text Completion**
+3. **Flutter Text Completion**
     ```dart
     import 'package:cactus/cactus.dart';
 
-    Future<String> basicCompletion() async {
-    // Initialize context
-    final context = await CactusContext.init(CactusInitParams(
-        modelPath: '/path/to/model.gguf',
-        contextSize: 2048,
-        threads: 4,
-    ));
-
-    // Generate response
-    final result = await context.completion(CactusCompletionParams(
-        messages: [
-        ChatMessage(role: 'user', content: 'Hello, how are you?')
-        ],
-        maxPredictedTokens: 100,
-        temperature: 0.7,
-    ));
-
-    context.free();
-    return result.text;
-    }
+    // Initialize
+    final lm = await CactusLM.init(
+        modelUrl: 'huggingface/gguf/link',
+        nCtx: 2048,
+    );
+
+    // Completion 
+    final messages = [CactusMessage(role: CactusMessageRole.user, content: 'Hello!')];
+    final params = CactusCompletionParams(nPredict: 100, temperature: 0.7);
+    final response = await lm.completion(messages, params);
+
+    // Embedding 
+    final text = 'Your text to embed';
+    final params = CactusEmbeddingParams(normalize: true);
+    final result = await lm.embedding(text, params);
     ```
-  To learn more, see the [Flutter Docs](https://github.com/cactus-compute/cactus/blob/main/docs/flutter.md). It covers chat design, embeddings, multimodal models, text-to-speech, and more.
+4. **Flutter VLM Completion**
+    ```dart
+    import 'package:cactus/cactus.dart';
+
+    // Initialize (Flutter handles downloads automatically)
+    final vlm = await CactusVLM.init(
+        modelUrl: 'huggingface/gguf/link',
+        mmprojUrl: 'huggingface/gguf/mmproj/link',
+    );
+
+    // Multimodal Completion (can add multiple images)
+    final messages = [CactusMessage(role: CactusMessageRole.user, content: 'Describe this image')];
+
+    final params = CactusVLMParams(
+        images: ['/absolute/path/to/image.jpg'],
+        nPredict: 200,
+        temperature: 0.3,
+    );
+
+    final response = await vlm.completion(messages, params);
+    ```
+  N/B: See the [Flutter Docs](https://github.com/cactus-compute/cactus/blob/main/flutter). It covers chat design, embeddings, multimodal models, text-to-speech, and more.
 
 ## ![React Native](https://img.shields.io/badge/React%20Native-grey.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)
 
@@ -94,29 +110,45 @@ Cactus is a lightweight, high-performance framework for running AI models on mob
     npx pod-install
     ```
 
-3. **Basic React-Native Text Completion**
+3. **React-Native Text Completion**
     ```typescript
-    import { initLlama } from 'cactus-react-native';
-
-    // Initialize a context
-    const context = await initLlama({
-        model: '/path/to/your/model.gguf',
+    // Initialize
+    const lm = await CactusLM.init({
+        model: '/path/to/model.gguf',
         n_ctx: 2048,
-        n_threads: 4,
     });
 
-    // Generate text
-    const result = await context.completion({
-        messages: [
-            { role: 'user', content: 'Hello, how are you?' }
-        ],
-        n_predict: 100,
-        temperature: 0.7,
+    // Completion 
+    const messages = [{ role: 'user', content: 'Hello!' }];
+    const params = { n_predict: 100, temperature: 0.7 };
+    const response = await lm.completion(messages, params);
+
+    // Embedding 
+    const text = 'Your text to embed';
+    const params = { normalize: true };
+    const result = await lm.embedding(text, params);
+    ```
+
+4. **React-Native VLM**
+    ```typescript
+    // Initialize
+    const vlm = await CactusVLM.init({
+        model: '/path/to/vision-model.gguf',
+        mmproj: '/path/to/mmproj.gguf',
     });
 
-    console.log(result.text);
+    // Multimodal Completion (can add multiple images)
+    const messages = [{ role: 'user', content: 'Describe this image' }];
+
+    const params = {
+        images: ['/absolute/path/to/image.jpg'],
+        n_predict: 200,
+        temperature: 0.3,
+    };
+
+    const response = await vlm.completion(messages, params);
     ```
- To learn more, see the [React Docs](https://github.com/cactus-compute/cactus/blob/main/docs/react.md). It covers chat design, embeddings, multimodal models, text-to-speech, and more.
+N/B: See the [React Docs](https://github.com/cactus-compute/cactus/blob/main/react). It covers chat design, embeddings, multimodal models, text-to-speech, and various options.
 
 ## ![C++](https://img.shields.io/badge/C%2B%2B-grey.svg?style=for-the-badge&logo=c%2B%2B&logoColor=white)
 
@@ -192,7 +224,7 @@ Cactus backend is written in C/C++ and can run directly on any ARM/X86/Raspberry
         return 0;
     }
     ```
- To learn more, see the [C++ Docs](https://github.com/cactus-compute/cactus/blob/main/docs/cpp.md). It covers chat design, embeddings, multimodal models, text-to-speech, and more.
+ To learn more, see the [C++ Docs](https://github.com/cactus-compute/cactus/blob/main/cactus). It covers chat design, embeddings, multimodal models, text-to-speech, and more.
 
 
 ## ![Using this Repo & Example Apps](https://img.shields.io/badge/Using_Repo_And_Examples-grey.svg?style=for-the-badge)
@@ -202,7 +234,7 @@ First, clone the repo with `git clone https://github.com/cactus-compute/cactus.g
 1. **Flutter**
     - Build the Android JNILibs with `scripts/build-flutter-android.sh`.
     - Build the Flutter Plugin with `scripts/build-flutter-android.sh`.
-    - Navigate to the example app with `cd examples/flutter`.
+    - Navigate to the example app with `cd flutter/example`.
     - Open your simulator via Xcode or Android Studio, [walkthrough](https://medium.com/@daspinola/setting-up-android-and-ios-emulators-22d82494deda) if you have not done this before.
     - Always start app with this combo `flutter clean && flutter pub get && flutter run`.
     - Play with the app, and make changes either to the example app or plugin as desired.
@@ -210,19 +242,24 @@ First, clone the repo with `git clone https://github.com/cactus-compute/cactus.g
 2. **React Native**
     - Build the Android JNILibs with `scripts/build-react-android.sh`.
     - Build the Flutter Plugin with `scripts/build-react-android.sh`.
-    - Navigate to the example app with `cd examples/react`.
+    - Navigate to the example app with `cd react/example`.
     - Setup your simulator via Xcode or Android Studio, [walkthrough](https://medium.com/@daspinola/setting-up-android-and-ios-emulators-22d82494deda) if you have not done this before.
     - Always start app with this combo `yarn && yarn ios` or `yarn && yarn android`.
     - Play with the app, and make changes either to the example app or package as desired.
     - For now, if changes are made in the package, you would manually copy the files/folders into the `examples/react/node_modules/cactus-react-native`.
 
 2. **C/C++**
-    - Navigate to the example app with `cd examples/cpp`.
+    - Navigate to the example app with `cd cactus/example`.
     - There are multiple main files `main_vlm, main_llm, main_embed, main_tts`.
     - Build both the libraries and executable using `build.sh`.
     - Run with one of the executables `./cactus_vlm`, `./cactus_llm`, `./cactus_embed`, `./cactus_tts`.
     - Try different models and make changes as desired.
 
+4. **Contributing**
+    - To contribute a bug fix, create a branch after making your changes with `git checkout -b <branch-name>` and submit a PR. 
+    - To contribute a feature, please raise as issue first so it can be discussed, to avoid intersecting with someone else.
+    - [Join our discord](https://discord.gg/SdZjmfWQ)
+
 ## ![Performance](https://img.shields.io/badge/Performance-grey.svg?style=for-the-badge)
 
 | Device                        |  Gemma3 1B Q4 (toks/sec) |    Qwen3 4B Q4 (toks/sec)   |  
@@ -256,3 +293,6 @@ We created a demo chat app we use for benchmarking:
 
 [![Download App](https://img.shields.io/badge/Download_iOS_App-grey?style=for-the-badge&logo=apple&logoColor=white)](https://apps.apple.com/gb/app/cactus-chat/id6744444212)
 [![Download App](https://img.shields.io/badge/Download_Android_App-grey?style=for-the-badge&logo=android&logoColor=white)](https://play.google.com/store/apps/details?id=com.rshemetsubuser.myapp&pcampaignid=web_share)
+
+## ![Recommendations](https://img.shields.io/badge/Our_Recommendations-grey.svg?style=for-the-badge)
+We provide a colleaction of recommended models on our [HuggingFace Page](https://huggingface.co/Cactus-Compute?sort_models=alphabetical#models)