Add model card README

README.md

@@ -0,0 +1,50 @@
+---
+library_name: kokoro-runtime-swift
+license: other
+pipeline_tag: text-to-speech
+---
+
+# Kokoro Runtime Swift Bundles
+
+Public model bundles for the Swift package:
+- GitHub package: https://github.com/mweinbach/kokoro-runtime-swift
+
+This repo hosts two downloadable archives:
+- `kokoro-mlx-bundle.zip`
+- `kokoro-coreml-bundle.zip`
+
+## Intended usage
+
+Use the CLI from the Swift package:
+
+```bash
+swift run kokoro-runtime download --backend all --output-dir ./kokoro-bundle
+swift run kokoro-runtime compile-coreml --bundle-dir ./kokoro-bundle
+swift run kokoro-runtime run --backend mlx --bundle-dir ./kokoro-bundle --voice af_heart --phonemes "həlˈO wˈɜɹld."
+swift run kokoro-runtime run --backend coreml --bundle-dir ./kokoro-bundle --voice af_heart --phonemes "həlˈO wˈɜɹld."
+```
+
+## Bundle contents
+
+### `kokoro-mlx-bundle.zip`
+Contains:
+- `config.json`
+- `kokoro-v1_0.safetensors`
+- `voices/*.safetensors`
+- `mlx.metallib`
+- conversion metadata
+
+### `kokoro-coreml-bundle.zip`
+Contains:
+- `Artifacts/models/*.mlpackage`
+- `Artifacts/manifest.json`
+- `Artifacts/config.json`
+- `Artifacts/harmonic_source.json`
+- `Artifacts/voices/*.bin`
+- `Artifacts/voices/voices.json`
+
+## Notes
+
+- These bundles are for local Swift runtime use.
+- The current runtime path is phoneme-input oriented.
+- Core ML bundles should be compiled locally with `compile-coreml` before first use.