From ff9c8315c1a330e03d05897792a54e4725e5527f Mon Sep 17 00:00:00 2001
From: Kistaro Windrider <kistaro@gmail.com>
Date: Mon, 5 Feb 2024 20:04:51 -0800
Subject: [PATCH] Document flags (correctly).

---
 README.md | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index fc47fdd..7150abb 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,13 @@ A deeply unsatisfying word search.
 1. [install the Go compiler](https://go.dev/dl/) if you don't have it yet
 2. clone this repo (`git clone https://git.chromaticdragon.app/kistaro/uckf.git`)
 3. `go run uckf.go`
-4. you can use `-s` to specify a different grid size; for example, `go run uckf.go -s 100` will create a 100x100 unsatisfying word search
+4. you can use `-n` to specify a different grid size; for example, `go run uckf.go -n 100` will create a 100x100 unsatisfying word search
+
+### Flags
+
+* `-n <int>` -- use a grid with edges of length n
+* `-s` -- summary mode; do not print intermediate grids, only summaries
+* `-r=false` -- suppress final result (only print a summary for that)
 
 ## Notes