From 0de8b19313de9a0051b3a5c59ac4d31e9193f5c0 Mon Sep 17 00:00:00 2001
From: Theo <theo.hallenius@gmail.com>
Date: Wed, 27 Mar 2024 00:45:13 +0100
Subject: [PATCH] Updated Readme

---
 README.md | 37 +++++++++++++++++++++++++++++++++++--
 1 file changed, 35 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index b95fe96..3663d0d 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,38 @@
 # IncoHangman
 
-TODO: Write a project description
+Play a classical Hangman game on Inco - a privacy focused blockchain with fully homomorphic encryption and on-chain randomness. Rules are simple: guess a 4 letter word one letter at a time before the picture completes after 11 wrong guesses.
 
-Written with React + Svelte.
\ No newline at end of file
+Written with React + Svelte.
+
+
+# Dependencies
+The project uses the following dependencies:
+
+- @privy-io/react-auth for the Privy overlay
+- @twa-dev/sdk for Telegram Web API
+
+# How it works
+The game is written using two frameworks:
+- React for the Privy overlay.
+- Svelte for the game UI.
+
+App.tsx is managing state, using Privy hooks, connects to Inco and sends transactions, makes calls to faucet, etc.
+Game.svelte is rendering the game graphics and animations.
+
+# How to run locally
+To run the project locally, run the following commands:
+```bash
+npm install
+npm start
+```
+
+# How to deploy
+This project is deployed on GitHub Pages. To deploy, install github CLI
+```bash
+npm install -g gh
+```
+Then run
+
+```bash
+npm run deploy
+```