docs: update example command

charlesrocket · Aug 23, 2024 · 11b9829 · 11b9829
1 parent e880aa5
commit 11b9829
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -21,5 +21,5 @@ zig build
 ## Usage
 
 ```sh
-xtxf -d -p -c red -s crypto
+xtxf -p -m decimal -c red -s crypto
 ```
diff --git a/src/assets.zig b/src/assets.zig
@@ -7,11 +7,11 @@ pub const help_message =
     \\  ██░██   ░██    ██ ██   ░██
     \\ ██   ██   ██   ██  ░██   ██
     \\
-    \\{s}COMMAND: {s}
-    \\
-    \\{s}DESCRIPTION: {s}
+    \\{s}{s}
+    \\{s}{s}
     \\
     \\
 ;
 
 pub const opt_usage = "{u}{?u}{s} {s}{s?} <{s}:{s}>";
+pub const examples_header = "{s}EXAMPLE:\n";
diff --git a/src/main.zig b/src/main.zig
@@ -26,6 +26,7 @@ const Color = enum(u32) { default = tb.TB_DEFAULT, red = tb.TB_RED, green = tb.T
 pub const CommandT = cova.Command.Custom(.{
     .global_help_prefix = "xtxf-" ++ build_opt.head_hash[0..7],
     .help_header_fmt = assets.help_message,
+    .examples_header_fmt = assets.examples_header,
     .opt_config = .{
         .usage_fmt = assets.opt_usage,
     },
@@ -101,7 +102,9 @@ const ValueT = CommandT.ValueT;
 pub const setup_cmd: CommandT = .{
     .name = "xtxf",
     .description = "Binary matrix.",
-
+    .examples = &.{
+        "xtxf -p -m decimal -c red -s crypto",
+    },
     .opts = &.{
         .{
             .name = "color",