From daf8b36365bc90c0c8b9ce358ddb8eecd5d253e1 Mon Sep 17 00:00:00 2001
From: Fenris Wolf <fenris@folksprak.org>
Date: Wed, 30 Jul 2025 07:21:34 +0000
Subject: [PATCH] [add] readme

---
 readme.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 readme.md

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 "<strong>Hello, World!</strong>" | html-docwrap`
+