add readme

pyproject.toml

@@ -4,7 +4,7 @@ version = "0.1.0"
 description = ""
 authors = ["demisel <elias@demisel.space>"]
 readme = "README.md"
-packages = [{include = "messenger_1million_stats"}]
+packages = [{include = "million"}]
 
 [tool.poetry.dependencies]
 python = "^3.10"

readme.md

@@ -0,0 +1,39 @@
+# Messenger 1 Million
+
+## Dev environment setup
+
+### 1. Install poetry
+
+```bash
+curl -sSL https://install.python-poetry.org | python3 -
+```
+Optionally configure poetry to create virtual envs in project root directories
+```bash
+poetry config virtualenvs.in-project true
+```
+
+### 2. Setup a poetry virtual env
+```bash
+poetry shell
+```
+
+### 3. Install dependencies
+```bash
+poetry install
+```
+
+## Run scripts
+
+```bash
+python -m scripts.[script name]
+```
+
+### Examples : 
+
+```bash
+python -m scripts.find_holes
+```
+
+```bash
+python -m scripts.read_top
+```