Skip to content

Commit 3dfd7ee

Browse files
committed
README.md file created
0 parents  commit 3dfd7ee

File tree

1 file changed

+73
-0
lines changed

1 file changed

+73
-0
lines changed

README.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Render Protocol Spec
2+
3+
### Render Protocol specifications, contracts and definitions in protobuf for gRPC communication
4+
5+
---
6+
7+
## Overview
8+
9+
This repository serves as the **canonical source of truth** for the Render Protocol’s
10+
**specifications, contracts, and schema definitions**.
11+
12+
It is designed to define **language-agnostic, versioned protobuf contracts** that enable
13+
reliable and efficient communication between Render Protocol clients and servers using
14+
**gRPC**.
15+
16+
---
17+
18+
## Purpose
19+
20+
The primary intent of this repository is to:
21+
22+
- Define **protocol-level contracts** for Render Protocol
23+
- Establish a **stable, strongly-typed interface** between clients and servers
24+
- Enable consistent behavior across multiple platforms and implementations
25+
- Act as the foundation for **server-driven UI (SDUI)** communication
26+
27+
This repository **does not contain any runtime or business logic**.
28+
29+
---
30+
31+
## Scope (Initial Phase)
32+
33+
At the current stage, this repository exists to establish **structure and intent** only.
34+
35+
Detailed specifications, schemas, and API definitions will be introduced **after the core
36+
architecture and protocol design are finalized**.
37+
38+
---
39+
40+
## Non-Goals
41+
42+
- No server implementations
43+
- No client SDKs
44+
- No generated code
45+
- No tooling or code-generation setup at this stage
46+
47+
Those concerns will be handled in their respective repositories.
48+
49+
---
50+
51+
## Status
52+
53+
🚧 **Early stage / Planning phase**
54+
55+
The contents of this repository will evolve as the Render Protocol architecture matures.
56+
57+
---
58+
59+
## Related Repositories
60+
61+
This repository is part of the broader **Render Protocol** ecosystem, which includes:
62+
63+
- Client renderers (SwiftUI, Flutter, Compose)
64+
- Server implementations
65+
- Supporting tooling and infrastructure
66+
67+
Details will be linked once available.
68+
69+
---
70+
71+
## License
72+
73+
To be defined.

0 commit comments

Comments
 (0)