From 5020199fd171248bc209b8fc8cb25fe2fc55e2a7 Mon Sep 17 00:00:00 2001
From: Daylin Morgan <me@dayl.in>
Date: Tue, 7 Jan 2025 16:31:35 -0600
Subject: [PATCH] add basic example to docs

---
 src/hwylterm/hwylcli.nim | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/src/hwylterm/hwylcli.nim b/src/hwylterm/hwylcli.nim
index a520fa7..b5d13fe 100644
--- a/src/hwylterm/hwylcli.nim
+++ b/src/hwylterm/hwylcli.nim
@@ -1,5 +1,30 @@
 ##[
   # HwylCli
+
+  ## example program:
+
+  ```nim
+  import std/[strutils]
+  import hywlterm/hwylcli
+
+  hwylCli:
+    name "example"
+    flags:
+      count:
+        ? "# of times"
+        - n
+      input:
+        ? "content"
+        - i
+    run:
+      echo (input & " ").repeat(count)
+  ```
+
+  ```
+  $ example -n 2 --input "testing"
+  > testing testing
+  ```
+
 ]##
 
 import std/[