Update README.md

[k_transpose.git] / README.md

diff --git a/README.md b/README.md
index 780d08f4164c4ffed34c2e4dabbb70c4f36405dc..dd86eb6250d059c7d7359e14ab2a35b066bad88d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1 +1,23 @@
-top secret kremlin color transposition device
+# kremlin transpose
+*top secret kremlin color transposition device*
+
+transposes colors in web pages to match your ANSI terminal color theme.
+
+k_transpose starts a local http server (localhost/kt/) through which you browse the outside web in the form e.g. http://localhost/kt/google.com. both relative & explicit URLs/URIs are prepended to route through this local http server such that one can browse the web "normally" after specifying the transposition server once
+
+terminal colors are read from ~/.Xresources in the form 'URxvt\*color[0-16]:#RRGGBB' or '*color[0-16]:#RRGGBB'. *background: & *foreground: colors are used too, to determine light/dark theme context
+
+##colorspace transposition
+TODO
+
+### compilation/installation
+```
+make
+sudo make install
+```
+
+### running
+```
+# you likely need root to bind httpds to a local port
+sudo k_transpose
+```