From 0cad77fb39c16a084c569ce91fbc5d13c39b1033 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jonas=20R=C3=B6ger?= <jonas.roeger@tu-dortmund.de>
Date: Thu, 10 Sep 2026 16:27:27 +0200
Subject: [PATCH] docs: add readme

---
 README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..eb195d8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,60 @@
+# Wordle Solver
+
+This wordle solver uses an information theory based approach to evaluate the next-best-guess. It's heavily inspired by [3b1b's approach](https://www.youtube.com/watch?v=v68zYyaEmEA) on solving wordle.
+
+There are two ways to use the wordle-solver.
+
+1. a CLI tool
+2. a web interface
+
+
+# Docker
+
+#### CLI
+```sh
+docker run --rm -it git.jroeger.de/jonas/wordle-solver-rs 
+```
+
+#### web
+``` sh
+docker run -p 8080:80 --rm -it git.jroeger.de/jonas/wordle-solver-rs-web
+```
+
+# Nix
+
+#### CLI
+
+``` sh
+nix run .
+```
+
+#### Static web site
+
+``` sh
+nix build git+http://git.jroeger.de/jonas/wordle-solver-rs#wordle-solver-web
+```
+
+# Native
+
+#### CLI
+
+you will need to have `cargo` installed.
+
+```sh
+cargo run --profile release
+```
+
+#### web
+
+you need the following tools:
+- `wasm-pack`
+- `wasm-bindgen`
+- `cargo`
+- `nodejs`
+- `yarn`
+
+``` sh
+cd web
+yarn install
+yarn serve # or yarn build
+```