From 984c22948b70bd1cbfef9f2d514d42e27541c1f1 Mon Sep 17 00:00:00 2001
From: Jimmi Holst Christensen
Date: Wed, 30 Mar 2022 16:28:16 +0200
Subject: New `help` api that provides options as to how paramters are printed.

fixes \#28
---
 example/README.md.template | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

(limited to 'example/README.md.template')

diff --git a/example/README.md.template b/example/README.md.template
index b76ae45..8b12cd6 100644
--- a/example/README.md.template
+++ b/example/README.md.template
@@ -58,7 +58,8 @@ is generated at runtime.
 
 The `help` prints a simple list of all parameters the program can take. It expects the
 `Id` to have a `description` method and an `value` method so that it can provide that
-in the output.
+in the output. `HelpOptions` is passed to `help` to control how the help message is
+printed.
 
 ```zig
 {s}
@@ -66,8 +67,11 @@ in the output.
 
 ```
 $ zig-out/bin/help --help
-	-h, --help   	Display this help and exit.
-	-v, --version	Output version information and exit.
+    -h, --help
+            Display this help and exit.
+
+    -v, --version
+            Output version information and exit.
 ```
 
 ### `usage`
-- 
cgit v1.2.3