Skip to content

Commit d1c47e6

Browse files
authored
Enhance README with project overview and details
Added detailed project description, vision, core principles, roadmap, client SDKs, backend implementation, AI-first thinking, project status, and license information.
1 parent c47882e commit d1c47e6

File tree

1 file changed

+154
-1
lines changed

1 file changed

+154
-1
lines changed

README.md

Lines changed: 154 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,154 @@
1-
# renderprotocol.github.io
1+
# Render Protocol
2+
3+
**Render Protocol** is an open-source, **server-driven UI framework** for modern mobile platforms, starting with **SwiftUI** and **Flutter**, and expanding to **Jetpack Compose**.
4+
5+
The goal is to enable **dynamic, schema-driven UIs** powered by backend configuration and AI systems — without sacrificing native performance or platform idioms.
6+
7+
> 🚧 This project is in its **early foundation phase**.
8+
> Repositories are currently initialized as **blank packages** while architecture and core schemas are being finalized.
9+
10+
---
11+
12+
## 🎯 Vision
13+
14+
Build a **platform-agnostic UI rendering protocol** that allows:
15+
16+
- Rendering native UI from **JSON / schema definitions**
17+
- Backend-controlled UI updates without app redeploys
18+
- AI systems (LLMs) to generate **valid, renderable UI schemas**
19+
- Strong separation of **design, logic, and presentation**
20+
- First-class support for **mobile-only experiences**
21+
22+
Render Protocol is **not a web abstraction layer** — it embraces native frameworks and performance.
23+
24+
---
25+
26+
## 🧠 Core Principles
27+
28+
- **Server-Driven, Native-Rendered**
29+
- **Schema First**
30+
- **Mobile-Only Focus**
31+
- **AI-Compatible UI Generation**
32+
- **Open-Source & Self-Hostable**
33+
- **Extensible & Incremental**
34+
35+
---
36+
37+
## 🗺️ Roadmap (High Level)
38+
39+
### Phase 1 – Foundations (Current)
40+
- Define platform-generic UI schema
41+
- Client-side renderers for SwiftUI & Flutter
42+
- Networking, caching, and schema validation
43+
- Authentication hooks
44+
45+
### Phase 2 – AI & Tooling
46+
- LLM-friendly schema definitions
47+
- UI generation during user interaction
48+
- Schema introspection & validation tools
49+
- Drag-and-drop UI builder (backend-driven)
50+
51+
### Phase 3 – Ecosystem
52+
- Jetpack Compose parity
53+
- Protobuf / binary schema support
54+
- Performance instrumentation
55+
- Advanced state & event handling
56+
57+
---
58+
59+
## 📦 Repositories
60+
61+
### 🧩 Client SDKs
62+
63+
#### **RenderProtocolSwift**
64+
Native Swift package for **SwiftUI** rendering.
65+
66+
Planned features:
67+
- Schema → SwiftUI renderer
68+
- Native layout & styling mapping
69+
- State & action handling
70+
- Networking, cache & auth modules
71+
72+
Status: **Initialized (empty package)**
73+
74+
---
75+
76+
#### **fl_render_protocol**
77+
Flutter implementation of Render Protocol.
78+
79+
Planned features:
80+
- Schema → Flutter widget renderer
81+
- Platform-agnostic UI definitions
82+
- Shared schema compatibility with SwiftUI
83+
84+
Status: **Initialized (empty package)**
85+
86+
---
87+
88+
#### **render-protocol-compose**
89+
Jetpack Compose (Kotlin) renderer.
90+
91+
Planned features:
92+
- Schema → Compose UI mapping
93+
- Android-first optimizations
94+
- Parity with SwiftUI & Flutter APIs
95+
96+
Status: **Initialized (empty package)**
97+
98+
---
99+
100+
### 🖥️ Backend
101+
102+
#### **render_protocol_server**
103+
Backend reference implementation.
104+
105+
Planned features:
106+
- Schema storage & versioning
107+
- Authentication & authorization
108+
- UI delivery APIs
109+
- Future UI builder & AI integration
110+
111+
Language/runtime is intentionally flexible to allow experimentation.
112+
113+
Status: **Initialized (empty package)**
114+
115+
---
116+
117+
## 🤖 AI-First Thinking
118+
119+
Render Protocol is designed so that:
120+
121+
- An LLM can **reason about supported UI components**
122+
- Generated responses can return **UI instead of text**
123+
- Client SDKs can safely render AI-generated layouts
124+
125+
This enables:
126+
- Conversational UIs
127+
- Adaptive screens
128+
- Context-aware layouts
129+
130+
---
131+
132+
## 🌱 Project Status
133+
134+
- Early architecture & schema design phase
135+
- APIs and folder structures are **not final**
136+
- Expect breaking changes during v0.x
137+
- Contributions & discussions welcome once foundations are set
138+
139+
---
140+
141+
## 🔗 Learn More
142+
143+
- GitHub Org: https://github.com/renderprotocol
144+
145+
---
146+
147+
## 📜 License
148+
149+
Licensing details will be finalized once core architecture stabilizes.
150+
The intent is to keep Render Protocol **open, extensible, and community-friendly**.
151+
152+
---
153+
154+
**Render once. Control everywhere.**

0 commit comments

Comments
 (0)