From de87430f94e660b44ae51f07a0bbe312e8953f5f Mon Sep 17 00:00:00 2001 From: clsource Date: Mon, 25 May 2026 19:05:02 -0400 Subject: [PATCH 1/2] docs: improved readme with mermaid and logo --- README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 1dd03e41..3c5baf18 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Mob +Mob Logo + BEAM-on-device mobile framework for Elixir. OTP runs inside your iOS and Android apps — embedded directly in the app bundle, no server required. Screens are GenServers; the UI is rendered by Compose and SwiftUI via a thin NIF. [![Hex.pm](https://img.shields.io/hexpm/v/mob.svg)](https://hex.pm/packages/mob) @@ -9,14 +11,17 @@ BEAM-on-device mobile framework for Elixir. OTP runs inside your iOS and Android ## What it is -``` -Your Elixir app (GenServers, OTP supervision, pattern matching, pipes) - ↓ - Mob.Screen (GenServer — your logic lives here) - ↓ - Mob.Renderer (component tree → JSON → NIF call) - ↓ -Compose (Android) SwiftUI (iOS) ← native rendering, native gestures +```mermaid +flowchart TD + A["Your Elixir app
(GenServers, OTP supervision, pattern matching, pipes)"] + B["Mob.Screen
(GenServer — your logic lives here)"] + C["Mob.Renderer
(component tree → JSON → NIF call)"] + D1["Compose (Android)
native rendering, gestures"] + D2["SwiftUI (iOS)
native rendering, gestures"] + + A --> B --> C + C --> D1 + C --> D2 ``` You write Elixir. The native layer handles rendering. The BEAM node runs on the device — connect your dev machine to the running app over Erlang distribution, inspect state, and hot-push new bytecode without a restart. From 158d17a725d5fff39a259c9fba2532b4a19e7d51 Mon Sep 17 00:00:00 2001 From: clsource Date: Mon, 25 May 2026 19:20:28 -0400 Subject: [PATCH 2/2] added warning label --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 3c5baf18..7bc53f69 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ BEAM-on-device mobile framework for Elixir. OTP runs inside your iOS and Android [![Hex.pm](https://img.shields.io/hexpm/v/mob.svg)](https://hex.pm/packages/mob) [![Docs](https://img.shields.io/badge/docs-hexdocs-blue.svg)](https://hexdocs.pm/mob) +> [!WARNING] > **Status:** Early development. Android emulator and iOS simulator confirmed working. Not yet ready for production use. ## What it is