[DX-2774] docs: game-bridge readme (#1821)

immutable · May 23, 2024 · 2cbdf4b · 2cbdf4b
1 parent addb219
commit 2cbdf4b
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/packages/game-bridge/README.md b/packages/game-bridge/README.md
@@ -0,0 +1,27 @@
+<div align="center">
+  <p align="center">
+    <a href="https://docs.x.immutable.com/docs">
+      <img src="https://cdn.dribbble.com/users/1299339/screenshots/7133657/media/837237d447d36581ebd59ec36d30daea.gif" width="280"/>
+    </a>
+  </p>
+  <h1>Immutable Game Bridge</h1>
+</div>
+
+## How to Create Index Files for Immutable Unity and Unreal SDK
+
+1. In the root directory of this repository, run:
+```bash
+yarn install
+```
+2. Navigate to the game-bridge directory:
+```bash
+`cd packages/game-bridge`
+```
+3. Build the files:
+```bash
+yarn build
+```
+
+The bundled index files will be generated in the following locations:
+- Unity: `game-bridge/dist/unity/index.html`
+- Unreal: `game-bridge/dist/unreal/index.js`