readme

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
+