about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 77fe625..0638e19 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,23 @@ This Python package depends on [bleach] for HTML sanitising
 and [markdown] for, well, rendering Markdown to HTML.  It is, however,
 not designed to work with HTML emails with all those CSS and Java scripts.
 
+## Usage
+
+```console
+$ formbox --help
+usage: formbox [-h] mbox id template
+
+format mbox as HTML/XML
+
+positional arguments:
+  mbox        path to mbox file
+  id          root message ID
+  template    path to template
+
+optional arguments:
+  -h, --help  show this help message and exit
+```
+
 ## Copying
 
 This program is free software: you can redistribute it and/or modify