Skip to content

docs: improved readme with mermaid and logo#31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
GenericJam merged 2 commits into from
May 27, 2026
Merged

docs: improved readme with mermaid and logo #31

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de87430
docs: improved readme with mermaid and logo
clsource May 25, 2026
158d17a
added warning label
clsource May 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,28 @@
# Mob

<img src="logo.svg" width="15%" alt="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)
[![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

```
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<br/>(GenServers, OTP supervision, pattern matching, pipes)"]
B["Mob.Screen<br/>(GenServer — your logic lives here)"]
C["Mob.Renderer<br/>(component tree → JSON → NIF call)"]
D1["Compose (Android)<br/>native rendering, gestures"]
D2["SwiftUI (iOS)<br/>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.
Expand Down