Merge pull request #14 from radiant-labs/codenikel/readme-updates

Adds collaborative editing instructions

README.md

@@ -21,6 +21,14 @@ RadiantKit is an in-development framework to build graphics applications (like F
 
 It introduces a node-component-system for efficient rendering, while ensuring complete extensibility. It can support both native and web (via WebAssembly) platforms.
 
+## Updates
+
+RadiantKit now supports real-time collaborative editing. Check out the instructions in the section title <a href="#collaborative-editing">Collaborative Editing</a> to set it up.
+
+<a href="#collaborative-editing">
+  <img src="CollaborativeEditing.gif" alt="Collaborative Editing Demo">
+</a>
+
 ## Basic Example
 
 Install rust and follow these steps:
@@ -45,5 +53,20 @@ Install yarn and follow these steps:
 
 Follow steps for web till #3. Then, run `yarn tauri dev`.
 
+## Collaborative Editing
+
+Run the backend server:
+1. `cd backend`
+2. `cargo r`
+
+Run egui app with a client id of 2:
+1. `cd examples/egui`
+2. `cargo r 2`
+
+Run the whiteboard app (which runs with a default client id of 4):
+1. `cd apps/whiteboard`
+2. `yarn install`
+3. `yarn start`
+
 ## Contact
 Send us an email at [hello@radiantkit.xyz](mailto:hello@radiantkit.xyz). You can also [join our slack](https://join.slack.com/t/radiantkit/shared_invite/zt-25isowtr6-jg3wHcQjRuLxyeT_fELO9Q) for quick help and support.