From 4b53ac3001b96ebd103f2d7b284e56ec44ad3272 Mon Sep 17 00:00:00 2001
From: Tom Ruff <tom@ruff.co.il>
Date: Mon, 7 Oct 2024 13:01:05 +0300
Subject: [PATCH] Update README.md

---
 README.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 62 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 9edab96..4be3e94 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,62 @@
-# otomai
- short amai visual novel
+# Otomai: A Harucon Easter Egg ✨
+
+**Otomai** is a short Ren'Py visual novel game created as a secret easter egg for the Israeli anime and sci-fi convention, Harucon. 
+
+This project is a single-player, narrative-driven experience built with the Ren'Py visual novel engine. 
+
+**Note:** This game is currently intended as a web experience running inside a Docker container. 
+
+### Features
+
+* Short, interactive visual novel experience
+* Original story and characters
+* A fun (hopefully!) surprise for Harucon attendees
+
+### Getting Started
+
+**Prerequisites**
+
+**For building the game from source**
+* Python3 installed
+* Ren'Py installed
+
+**For running the game inside a docker container**
+* Docker installed on your system. You can find installation instructions for your OS on the official Docker website: [https://www.docker.com/products/docker-desktop/](https://www.docker.com/products/docker-desktop/)
+
+**Building the Game**
+
+1. Clone this repository:
+```
+git clone https://git.ruff.co.il/amai.ig/otomai.git
+```
+2. Using Ren'Py, load the source and build for your desired platform.
+3. Run the final compiled result.
+
+**Running the game inside a docker container**
+
+1. Pull the docker image:
+```
+docker pull git.ruff.co.il/amai.ig/otomai:latest
+```
+2. Start a container with port 5000 exposed:
+```
+docker run git.ruff.co.il/amai.ig/otomai:latest -p 5000:80 --name otomai
+```
+3. Open your web browser and navigate to `http://docker-host:5000`
+
+This should launch the Otomai game within your web browser.
+
+### Contributing
+
+We welcome contributions to this project! If you'd like to help with development, please open a pull request on this repository. 
+
+### License
+
+This project is licensed under the MIT License. See the `LICENSE` file for details. 
+
+
+### Contact
+
+For any questions or feedback, feel free to open an issue on this repository.
+
+We hope you enjoy your Otomai experience!
\ No newline at end of file