Revise SDK README badge and nav row policy for consistency
- Update badge row guidance: root README uses full badge wall; SDK READMEs use only their primary registry, Website, and License badges. - Add explicit badge and nav row HTML snippets for each SDK. - Require a cross-SDK nav row in every SDK README. - Update example app README structure for clarity. - Adjust taglines for natural language and cross-SDK consistency. - Update Dart, Kotlin, and React Native README badge and nav rows to match new policy.
keypair34 committed
Apr 26, 2026 at 22:28 UTC
d766d47a24f63a27e04cbf8f7623dea1f9a06ea8
4 files changed
+80
-28
.agents/skills/sdk-branding/SKILL.md
+72
-18
@@ -155,20 +155,71 @@ Width: `96` for top-level READMEs. Use `72` for secondary pages (example apps, s
155
156
### Badge row
157
158
-Use this exact pattern in every top-level README. Adjust the registry badge to match the file's context (pub.dev for Dart, crates.io for Rust):
158
+Badge policy depends on the README type.
159
+
160
+**Root README (`onde/README.md`)**
161
+
162
+Use the full ecosystem badge wall here. This is the hub page for the whole SDK family.
163
160
-**Dart / Flutter SDK:**
164
```html
165
+<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>
166
+<a href="https://central.sonatype.com/artifact/com.ondeinference/onde-inference"><img src="https://img.shields.io/maven-central/v/com.ondeinference/onde-inference?style=flat-square&color=235843&labelColor=17211D&label=maven" alt="Maven Central"></a>
167
+<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>
168
<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>
169
+<a href="https://www.npmjs.com/package/@ondeinference/react-native"><img src="https://img.shields.io/npm/v/@ondeinference/react-native?style=flat-square&color=235843&labelColor=17211D&label=npm" alt="npm"></a>
170
<a href="https://ondeinference.com"><img src="https://img.shields.io/badge/ondeinference.com-235843?style=flat-square&labelColor=17211D" alt="Website"></a>
171
<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>
172
```
173
174
+**SDK README**
175
+
176
+Use one primary registry badge for that SDK, plus `Website` and `License`. Do not repeat the full ecosystem badge wall on every SDK page.
177
+
178
+**Flutter / Dart SDK:**
179
+```html
180
+<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>
181
+<a href="https://ondeinference.com"><img src="https://img.shields.io/badge/ondeinference.com-235843?style=flat-square&labelColor=17211D" alt="Website"></a>
182
+<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>
183
+```
184
+
185
**Rust SDK:**
186
```html
187
<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>
188
<a href="https://ondeinference.com"><img src="https://img.shields.io/badge/ondeinference.com-235843?style=flat-square&labelColor=17211D" alt="Website"></a>
171
-<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>
189
+<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>
190
+```
191
+
192
+**Kotlin Multiplatform SDK:**
193
+```html
194
+<a href="https://central.sonatype.com/artifact/com.ondeinference/onde-inference"><img src="https://img.shields.io/maven-central/v/com.ondeinference/onde-inference?style=flat-square&color=235843&labelColor=17211D&label=maven" alt="Maven Central"></a>
195
+<a href="https://ondeinference.com"><img src="https://img.shields.io/badge/ondeinference.com-235843?style=flat-square&labelColor=17211D" alt="Website"></a>
196
+<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>
197
+```
198
+
199
+**React Native SDK:**
200
+```html
201
+<a href="https://www.npmjs.com/package/@ondeinference/react-native"><img src="https://img.shields.io/npm/v/@ondeinference/react-native?style=flat-square&color=235843&labelColor=17211D&label=npm" alt="npm"></a>
202
+<a href="https://ondeinference.com"><img src="https://img.shields.io/badge/ondeinference.com-235843?style=flat-square&labelColor=17211D" alt="Website"></a>
203
+<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>
204
+```
205
+
206
+**Swift SDK:**
207
+```html
208
+<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>
209
+<a href="https://ondeinference.com"><img src="https://img.shields.io/badge/ondeinference.com-235843?style=flat-square&labelColor=17211D" alt="Website"></a>
210
+<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>
211
+```
212
+
213
+### Cross-SDK nav row
214
+
215
+Every SDK README should include a centered text-link row under the badges. These sibling links matter for discovery, branding, and cross-SDK navigation.
216
+
217
+Use this pattern and adjust the current page's own SDK label if needed:
218
+
219
+```html
220
+<p align="center">
221
+ <a href="https://github.com/ondeinference/onde">Rust SDK</a> · <a href="https://github.com/ondeinference/onde-swift">Swift 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>
222
+</p>
223
```
224
225
### Footer
@@ -192,15 +243,15 @@ Use `— MIT License` on sub-pages (example apps, package-level docs). Omit it o
243
1. Centered logo block
244
2. Centered `<h1>` with SDK name
245
3. Centered tagline (`<p><strong>...</strong></p>`)
195
-4. Centered badge row
196
-5. Centered cross-SDK nav links (`Rust SDK · Swift SDK · Website`)
246
+4. Centered badge row with the SDK's primary registry badge, `Website`, and `License`
247
+5. Centered cross-SDK nav links (`Rust SDK · Swift SDK · Kotlin Multiplatform SDK · Flutter SDK · React Native SDK · Website`)
248
6. `---` divider
198
-7. `## Features` — bullet list with emoji prefix per feature
249
+7. A direct intro paragraph that explains what runs where and what the user gets
250
8. `## Platform support` — table: Platform | GPU backend | Default model | Notes
200
-9. `## Quick start` — `### Add the dependency`, `### Initialize`, then usage sections
201
-10. `## Model selection` — table + code examples
202
-11. `## Sampling` — presets table + code
203
-12. `## Error handling`
251
+9. `## Quick start` — install snippet, initialization, then usage sections
252
+10. `## Model selection` — table + code examples when relevant
253
+11. `## Sampling` — presets table + code when relevant
254
+12. `## Error handling` when relevant
255
13. `## Contributing`
256
14. `## License`
257
15. Footer
@@ -208,26 +259,29 @@ Use `— MIT License` on sub-pages (example apps, package-level docs). Omit it o
259
### Example app README
260
261
1. Centered logo block (width `96`)
211
-2. Centered `<h1>` with `— Example App` suffix
262
+2. Centered `<h1>` with `Example App` in the title
263
3. Centered one-line description (bold) + second line: `No server. No API key. No data leaving the device.`
213
-4. Centered badge row (identical to SDK README)
264
+4. Centered badge row for the parent SDK or example context
265
5. `---` divider
215
-6. `## What this example demonstrates` — feature table mapping feature → file/function
266
+6. `## What this example shows` — feature table mapping feature → file/function
267
7. `## Running the example` — Prerequisites, Steps, Platform notes table
268
8. `## SDK quick reference` — minimal happy-path snippet (load → stream → unload)
269
9. `## Project structure` — directory tree
219
-10. `## Learn more` — links to pub.dev, ondeinference.com, GitHub
270
+10. `## Learn more` — links to the package page, ondeinference.com, and GitHub
271
11. Footer
272
273
### Taglines
274
224
-Use these verbatim. Do not paraphrase.
275
+Use these as the default direction, but keep them natural if the page needs slightly different wording. Avoid stiff marketing language and avoid em dashes in prose.
276
277
| Context | Tagline |
278
|---|---|
228
-| Rust crate | `On-device LLM inference — optimized for Apple silicon.` |
229
-| Flutter SDK | `On-device LLM inference for Flutter & Dart — optimized for Apple silicon.` |
230
-| Example app | `A complete Flutter chat app running fully on-device LLM inference.` |
279
+| Rust crate | `Run LLMs on-device, with first-class support for Apple silicon.` |
280
+| Flutter SDK | `Run LLMs on-device from Flutter and Dart. Metal on iOS and macOS, CPU everywhere else.` |
281
+| Kotlin SDK | `Run LLMs on-device from Kotlin. No cloud, no API key, and no user data leaving the device.` |
282
+| React Native SDK | `Run LLMs on-device from React Native. Metal on iOS, CPU on Android, and no user data leaving the device.` |
283
+| Swift SDK | `Run LLMs on-device from Swift, with first-class support for Apple silicon.` |
284
+| Example app | `A Flutter chat app that runs LLM inference fully on-device.` |
285
286
---
287
sdk/dart/README.md
+2
-5
@@ -10,15 +10,12 @@
10
11
<p align="center">
12
<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://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>
14
- <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>
15
- <a href="https://www.npmjs.com/package/@ondeinference/react-native"><img src="https://img.shields.io/npm/v/@ondeinference/react-native?style=flat-square&color=235843&labelColor=17211D&label=npm" alt="npm"></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>
17
- <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">
21
- <a href="https://github.com/ondeinference/onde">Rust SDK</a> · <a href="https://swiftpackageindex.com/ondeinference/onde-swift">Swift SDK</a> · <a href="https://www.npmjs.com/package/@ondeinference/react-native">React Native SDK</a> · <a href="https://ondeinference.com">Website</a>
18
+ <a href="https://github.com/ondeinference/onde">Rust SDK</a> · <a href="https://swiftpackageindex.com/ondeinference/onde-swift">Swift SDK</a> · <a href="https://central.sonatype.com/artifact/com.ondeinference/onde-inference">Kotlin Multiplatform 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
---
sdk/kotlin/README.md
+5
-1
@@ -9,11 +9,15 @@
9
</p>
10
11
<p align="center">
12
- <a href="https://central.sonatype.com/artifact/com.ondeinference/onde-inference"><img src="https://img.shields.io/maven-central/v/com.ondeinference/onde-inference?style=flat-square&color=235843&labelColor=17211D&label=Maven%20Central" alt="Maven Central"></a>
12
+ <a href="https://central.sonatype.com/artifact/com.ondeinference/onde-inference"><img src="https://img.shields.io/maven-central/v/com.ondeinference/onde-inference?style=flat-square&color=235843&labelColor=17211D&label=maven" alt="Maven Central"></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>
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">
18
+ <a href="https://github.com/ondeinference/onde">Rust SDK</a> · <a href="https://github.com/ondeinference/onde-swift">Swift 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
---
22
23
## What is Onde?
sdk/react-native/README.md
+1
-4
@@ -10,11 +10,8 @@
10
11
<p align="center">
12
<a href="https://www.npmjs.com/package/@ondeinference/react-native"><img src="https://img.shields.io/npm/v/@ondeinference/react-native?style=flat-square&color=235843&labelColor=17211D&label=npm" alt="npm"></a>
13
- <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>
14
- <a href="https://central.sonatype.com/artifact/com.ondeinference/onde-inference"><img src="https://img.shields.io/maven-central/v/com.ondeinference/onde-inference?style=flat-square&color=235843&labelColor=17211D&label=Maven%20Central" alt="Maven Central"></a>
15
- <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>
16
- <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>
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">