From 2cbdf4b2a41eb6788b7a8d4083e1ca205531cadd Mon Sep 17 00:00:00 2001
From: Natalie <nf1993@gmail.com>
Date: Thu, 23 May 2024 13:56:08 +1200
Subject: [PATCH] [DX-2774] docs: game-bridge readme (#1821)

---
 packages/game-bridge/README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 packages/game-bridge/README.md

diff --git a/packages/game-bridge/README.md b/packages/game-bridge/README.md
new file mode 100644
index 0000000000..178009f500
--- /dev/null
+++ 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`