diff options
author | Nguyễn Gia Phong <mcsinyx@disroot.org> | 2021-12-29 21:09:08 +0700 |
---|---|---|
committer | Nguyễn Gia Phong <mcsinyx@disroot.org> | 2021-12-29 21:09:08 +0700 |
commit | 0085141cda79fe44aa0d04c8686849542023d99c (patch) | |
tree | 1b33c21c0ab116e0c59d0eddc5cca62eb62b072d /README.md | |
parent | 5d768106b7083ee3d9a66e6e947ecfc8dfeb35f4 (diff) | |
download | formbox-0085141cda79fe44aa0d04c8686849542023d99c.tar.gz |
Polish and document 0.1.0
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 17 |
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 |