summaryrefslogtreecommitdiff
path: root/makima/ios/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'makima/ios/README.md')
-rw-r--r--makima/ios/README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/makima/ios/README.md b/makima/ios/README.md
new file mode 100644
index 0000000..2a6a664
--- /dev/null
+++ b/makima/ios/README.md
@@ -0,0 +1,31 @@
+# Makima iOS
+
+Native iPhone client for [Makima](https://makima.jp) — distributed mesh listening and AI daemon orchestration platform by Soryu LTD.
+
+**Status:** pre-alpha (M0 scaffold). See [`docs/DEVELOPMENT.md`](docs/DEVELOPMENT.md).
+
+**Plan:** see `/root/notes/makima/ios-v1-plan.md` on the infra host, or the mirrored copy in `docs/PLAN.md` once synced.
+
+## Quick start
+
+```bash
+cd makima/ios
+make bootstrap # installs xcodegen if missing
+make ios-sim-fast # builds for iPhone 16 Pro simulator
+```
+
+Xcode 16+, iOS 18+ target, Swift 5.10+, pure SwiftUI. No third-party packages at M0/M1.
+
+## Architecture
+
+Pure native SwiftUI with `@Observable` stores, `URLSession` networking, `URLSessionWebSocketTask` for task livestream, SwiftData for local cache, Keychain for the `x-makima-api-key` credential.
+
+No cross-platform core, no React Native, no Expo. See `../../README.md` for the wider monorepo.
+
+## License
+
+MIT — see repo-root `LICENSE`.
+
+## Privacy
+
+No analytics. No telemetry. The app talks directly to the Makima server URL you configure — by default `https://makima.jp`, but any reachable instance works (`Settings → Server URL`). Credentials are stored in iOS Keychain, scoped per server URL. Full privacy policy: this README.