Update README with new badges, SDK links, and improved wording
keypair34 committed
Apr 26, 2026 at 22:25 UTC
27ebd83d13196fff5c3cbe4c42479c048ee41e40
1 file changed
+11
-13
README.md
+11
-13
@@ -5,19 +5,17 @@
5
<h1 align="center">Onde Inference</h1>
6
7
<p align="center">
8
- <strong>On-device LLM inference for Swift — optimized for <a href="https://en.wikipedia.org/wiki/Apple_silicon">Apple silicon</a>.</strong>
8
+ <strong>Run LLMs on-device from Swift, with first-class support for <a href="https://en.wikipedia.org/wiki/Apple_silicon">Apple silicon</a>.</strong>
9
</p>
10
11
<p align="center">
12
- <a href="https://crates.io/crates/onde"><img src="https://img.shields.io/crates/v/onde?style=flat-square&color=235843&labelColor=17211D&label=crates.io" alt="crates.io"></a>
12
<a href="https://swiftpackageindex.com/ondeinference/onde-swift"><img src="https://img.shields.io/badge/Swift%20Package%20Index-onde--swift-235843?style=flat-square&labelColor=17211D" alt="Swift Package Index"></a>
14
- <a href="https://pub.dev/packages/onde_inference"><img src="https://img.shields.io/pub/v/onde_inference?style=flat-square&color=235843&labelColor=17211D&label=pub.dev" alt="pub.dev"></a>
13
<a href="https://ondeinference.com"><img src="https://img.shields.io/badge/ondeinference.com-235843?style=flat-square&labelColor=17211D" alt="Website"></a>
16
- <a href="https://apps.apple.com/se/developer/splitfire-ab/id1831430993"><img src="https://img.shields.io/badge/App%20Store-live-235843?style=flat-square&labelColor=17211D" alt="App Store"></a>
14
+ <a href="https://github.com/ondeinference/onde/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-235843?style=flat-square&labelColor=17211D" alt="License"></a>
15
</p>
16
17
<p align="center">
20
- <a href="https://github.com/ondeinference/onde">Rust SDK</a> · <a href="https://pub.dev/packages/onde_inference">Flutter SDK</a> · <a href="https://ondeinference.com">Website</a>
18
+ <a href="https://github.com/ondeinference/onde">Rust SDK</a> · <a href="https://central.sonatype.com/artifact/com.ondeinference/onde-inference">Kotlin Multiplatform SDK</a> · <a href="https://pub.dev/packages/onde_inference">Flutter SDK</a> · <a href="https://www.npmjs.com/package/@ondeinference/react-native">React Native SDK</a> · <a href="https://ondeinference.com">Website</a>
19
</p>
20
21
## Compatibility
@@ -29,7 +27,7 @@
27
28
## Installation
29
32
-In Xcode: **File → Add Package Dependencies** and enter:
30
+In Xcode, open **File → Add Package Dependencies** and enter:
31
32
```
33
https://github.com/ondeinference/onde-swift
@@ -63,9 +61,9 @@ import Onde
61
62
let engine = OndeChatEngine()
63
66
-// Load the platform-appropriate default model:
67
-// iOS / tvOS → Qwen 2.5 1.5B (~941 MB)
68
-// macOS → Qwen 2.5 3B (~1.93 GB)
64
+// Load the default model for the current device:
65
+// iOS / tvOS → Qwen 2.5 Coder 1.5B (~941 MB)
66
+// macOS → Qwen 2.5 Coder 3B (~1.93 GB)
67
let elapsed = try await engine.loadDefaultModel(
68
systemPrompt: "You are a helpful assistant.",
69
sampling: nil
@@ -96,7 +94,7 @@ try await streamChatMessage(
94
95
## One-Shot Generation
96
99
-Run inference without modifying conversation history:
97
+This runs inference without changing conversation history:
98
99
```swift
100
let result = try await engine.generate(
@@ -107,7 +105,7 @@ let result = try await engine.generate(
105
106
## Sandboxed App Setup
107
110
-On iOS and App Store macOS, the default `~/.cache/huggingface` is outside the app sandbox. This helper seeds `HF_HOME` inside the App Group shared container (`group.com.ondeinference.apps`) so all Onde-powered apps share downloaded models. Call once at app launch before creating an `OndeChatEngine`.
108
+On iOS and App Store macOS, the default `~/.cache/huggingface` path sits outside the app sandbox. This helper points `HF_HOME` at the App Group shared container (`group.com.ondeinference.apps`) so Onde-powered apps can share downloaded models. Call it once at app launch before creating an `OndeChatEngine`.
109
110
```swift
111
import Foundation
@@ -116,7 +114,7 @@ func setupInferenceEnvironment() {
114
guard let container = FileManager.default.containerURL(
115
forSecurityApplicationGroupIdentifier: "group.com.ondeinference.apps"
116
) else {
119
- // Fall back to app-private Application Support if App Group is unavailable.
117
+ // Fall back to the app's private Application Support directory if the App Group is unavailable.
118
let appSupport = FileManager.default
119
.urls(for: .applicationSupportDirectory, in: .userDomainMask)[0]
120
setupHfCache(at: appSupport)
@@ -147,7 +145,7 @@ private func setupHfCache(at base: URL) {
145
146
## License
147
150
-Onde is dual-licensed under **MIT** and **Apache 2.0**. You may use it under either license at your option.
148
+Onde is dual-licensed under **MIT** and **Apache 2.0**. You can use either one.
149
150
- [MIT License](https://github.com/ondeinference/onde/blob/main/LICENSE-MIT)
151
- [Apache License 2.0](https://github.com/ondeinference/onde/blob/main/LICENSE-APACHE)