diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..77fe625 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# formbox + +This tiny script formats an [mbox] as HTML or XML. It is intended +for rendering email replies on websites and their [RSS] feed. + +## Prerequisites + +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. + +## Copying + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU Affero General Public License as published +by the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +[mbox]: https://en.wikipedia.org/wiki/Mbox +[RSS]: https://www.rssboard.org +[bleach]: https://bleach.readthedocs.io +[markdown]: https://python-markdown.github.io |