From 6eaf1405d0deef1c4d05dbb146a6cbb903765463 Mon Sep 17 00:00:00 2001
From: Bruce Hill <bruce@bruce-hill.com>
Date: Sat, 7 Sep 2024 00:50:54 -0400
Subject: Document README

---
 docs/README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

(limited to 'docs/README.md')

diff --git a/docs/README.md b/docs/README.md
index 3c4e3d62..03c90596 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -68,6 +68,32 @@ something went wrong (e.g. the user hit `Ctrl-D`).
 
 ---
 
+### `exit`
+
+**Description:**  
+Exits the program with a given status and optionally prints a message.
+
+**Usage:**  
+```markdown
+ask(message:Text = "", status:Int32 = 0_i32) -> Void
+```
+
+**Parameters:**
+
+- `message`: If nonempty, this message will be printed (with a newline) before
+  exiting.
+- `status`: The status code that the program with exit with.
+
+**Returns:**  
+This function never returns.
+
+**Example:**  
+```markdown
+exit(status=1, "Goodbye forever!")
+```
+
+---
+
 ### `say`
 
 **Description:**  
-- 
cgit v1.2.3