minimal doc added

[overhosts.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..92cf863
--- /dev/null
+++ b/README
@@ -0,0 +1,11 @@
+Environment variables:
+
+OVERHOSTS_ALIASES - pipe separated list of aliased hosts
+OVERHOSTS_REAL - the target of host aliases
+
+Usage:
+
+$ export OVERHOSTS_ALIASES="alias1|alias2|alias3"
+$ export OVERHOSTS_REAL="targethost"
+$ LD_PRELOAD=overhosts.so <progname>
+