From cdf6957c1e1c132e57d1283daa14f16db86566f9 Mon Sep 17 00:00:00 2001
From: Adrien Abraham <aabraham@freebox.fr>
Date: Fri, 2 Sep 2022 18:46:52 +0200
Subject: [PATCH] readme

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.md b/README.md
index e69de29..5cc603a 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,18 @@
+Shrlok
+======
+
+Publish stuff on the Web by piping it to a Unix domain socket (WIP).
+
+Shrlok listens in the background on a Unix socket for a small header followed by
+data and pushes this data in a directory with some basic treatment. For example,
+text pushed to Shrlok is put into a `pre` tag of an HTML page.
+
+The current expected format is described at the top of the `shrlok.py` module.
+
+Supported types:
+
+- `txt`: put into a `pre` tag in an HTML page;
+- `raw`: put as is.
+
+Example: TODO
+