From 543e6b0cbc7012ce82fd0df9d00215579ddf3d14 Mon Sep 17 00:00:00 2001
From: Maxim Fomin <m.fomin@innopolis.university>
Date: Tue, 15 Oct 2024 20:54:45 +0300
Subject: [PATCH] chore: add README.md

---
 README.md | 35 ++++++++++++++++++++++++++++++++++-
 1 file changed, 34 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f962fe4..5dd3012 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,34 @@
-# InNoHassle-RoomsBot
+# Rooms Bot in InNoHassle ecosystem
+
+## Development
+
+### Getting started
+
+1. Install Python 3.12
+
+2. Install Poetry
+
+3. Install dependencies
+    ```bash
+    poetry install
+    ```
+
+4. Set up pre-commit hook
+    ```bash
+    poetry run pre-commit install
+    ```
+
+5. Set up settings file.
+    ```bash
+    cp example.env .env
+    ```
+   Insert your bot token and API token (see [API's README](https://github.com/one-zero-eight/rooms/blob/main/README.md) to obtain it).
+
+## Run
+
+Run an [API](https://github.com/one-zero-eight/rooms/) instance.
+
+Then, run the bot:
+```bash
+poetry run python -m src.bot.main
+```