From 2c669e6e11f837044759d40b8992601a1bd3d2c2 Mon Sep 17 00:00:00 2001
From: Dana Whitfield <dana@example.org>
Date: Wed, 26 Aug 2026 14:30:00 +0200
Subject: [PATCH] README: add an options table and a roadmap

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.md b/README.md
index bc46ffcd52f7ce861ff67d7a2eb09853c2896292..ceb153027f97f93ead65ba70faab6acd7bb5c6d1 100644
--- a/README.md
+++ b/README.md
@@ -27,6 +27,17 @@ $ hello-hut --time-of-day Grace
 Good evening, Grace!
 ```
 
+## Options
+
+| Option | Description | Default |
+| --- | --- | --- |
+| `NAME` | Who to greet | `friend` |
+| `--shout` | Print the greeting in capitals | off |
+| `--time-of-day` | Say good morning, afternoon or evening | off |
+| `--count N` | Repeat the greeting `N` times | `1` |
+| `--color WHEN` | `auto`, `always` or `never`; `NO_COLOR` is respected | `auto` |
+| `--format FORMAT` | `text` or `json` | `text` |
+
 ## Configuration
 
 Defaults can live in `~/.config/hello-hut/config.toml`:
@@ -38,6 +49,17 @@ shout = false
 
 Every key is described in [docs/configuration.md](docs/configuration.md).
 
+## Roadmap
+
+- [x] Positional `NAME` argument
+- [x] `--shout` and `--time-of-day`
+- [x] Configuration file
+- [x] `--count`, `--color` and `--format json`
+- [x] Bash and zsh completions
+- [ ] Localized greetings with `--lang`
+- [ ] A man page
+- [ ] ~~Rhyming greetings~~ (out of scope, see the tracker)
+
 ## Contributing
 
 Patches are welcome by email.