docs: add readme

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
+```

web/package.json

@@ -4,13 +4,14 @@
   "version": "0.0.0",
   "type": "module",
   "scripts": {
+    "serve": "run-s wasm-pack:release vite:serve",
     "build-no-wasm": "run-s tsc vite:build",
     "build": "run-s wasm-pack:release tsc vite:build",
     "dev": "run-s wasm-pack:dev vite:dev",
     "tsc": "tsc",
     "vite:build": "vite build",
     "vite:dev": "vite -c vite.config.dev.ts",
-    "vite:preview": "vite preview",
+    "vite:serve": "vite -c vite.config.ts",
     "wasm-pack:dev": "rm -rf pkg; wasm-pack build --dev --features wasm-bindgen --manifest-path ../Cargo.toml; mv ../pkg .",
     "wasm-pack:release": "rm -rf pkg; wasm-pack build --features wasm-bindgen --manifest-path ../Cargo.toml; mv ../pkg ."
   },