diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..abd98c3 --- /dev/null +++ b/readme.md @@ -0,0 +1,41 @@ +# html-docwrap + +reads an HTML string from `stdin`, wraps it into an HTML document with styling and prints the result to `stdout` + + +## Building + +### Requirements + +- shell interpreter + + +### Instructions + +- execute `tools/build` + + +## Installation + +### Requirements + +- shell interpreter + + +### Instructions + +- as `root`, execute `tools/install` + + +## Usage + +### Requirements + +- Python3 intpreter + + +### Instructions + +- see `html-docwrap -h` +- example: `echo "Hello, World!" | html-docwrap` +