Skip to content

Commit c22abd0

Browse files
committed
docs: add iOS demo GIF, iOS build instructions, and contributor Team ID note
1 parent d31ad49 commit c22abd0

2 files changed

Lines changed: 37 additions & 1 deletion

File tree

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ A blazingly fast, native Swift inference server that serves [MLX](https://github
44

55
No Python runtime, no Global Interpreter Lock (GIL), no unnecessary memory copies. Just bare-metal Apple Silicon performance compiled to a single binary.
66

7+
<p align="center">
8+
<img src="docs/demo.gif" width="320" alt="SwiftLM Chat iOS demo" />
9+
</p>
10+
711
## 🚀 Features
812

913
- 🍎 **100% Native Apple Silicon**: Powered natively by Metal and Swift.
@@ -56,7 +60,39 @@ To reliably run massive 122B parameter MoE models over SSD streaming, `SwiftLM`
5660
5761
---
5862

59-
## 🛠️ Quick Start
63+
---
64+
65+
## 📱 SwiftLM Chat — iOS App
66+
67+
A native iPhone & iPad companion app that downloads MLX models directly from HuggingFace and runs inference on-device via MLX Swift.
68+
69+
### Features
70+
- **Tab UI**: Chat · Models · Settings
71+
- **Live download progress** with speed indicator and circular progress ring
72+
- **Model catalog**: Qwen3, Phi-3.5, Mistral, Llama — with on-device RAM fit indicators
73+
- **HuggingFace search** — find any `mlx-community` model by name
74+
- **Context-aware empty states** — downloading ring, loading spinner, idle prompt
75+
- **iOS lifecycle hardened** — model unload only fires on true background (not notification banners); 30-second grace period on app-switch
76+
77+
### Build & Run (iOS)
78+
79+
```bash
80+
cd SwiftLMChat
81+
python3 generate_xcodeproj.py # Generates SwiftLMChat.xcodeproj
82+
open SwiftLMChat.xcodeproj
83+
```
84+
85+
Then in Xcode:
86+
1. Select the **SwiftLMChat** target → **Signing & Capabilities**
87+
2. Set your **Team** (your Apple Developer account)
88+
3. Select your iPhone as the run destination
89+
4. ⌘R to build and run
90+
91+
> **Note for contributors**: The `.xcodeproj` is git-ignored (it contains your personal Team ID). Run `generate_xcodeproj.py` after cloning to regenerate it locally. Your Team ID is never committed.
92+
93+
---
94+
95+
## 🛠️ Quick Start (macOS Server)
6096

6197
### Fastest: Download Pre-built Binary
6298
The absolute fastest way to get started is to [download the latest pre-compiled macOS binary](https://github.com/SharpAI/SwiftLM/releases) directly from the Releases page. Just extract it and run!

docs/demo.gif

5.75 MB
Loading

0 commit comments

Comments
 (0)