short instructions how to install and use

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..985e61f
--- /dev/null
+++ b/README
@@ -0,0 +1,34 @@
+Virtual LDAP is set of perl scripts which allows you to augment data in your
+existing LDAP server (which you don't want to modify) using ldap-rewrite.pl
+(supporting rewrite of bind request, search requests and responses).
+
+Alternative usage is to expose SQL database (currently Koha database with uses)
+to some other system as LDAP server.
+
+
+Install with:
+
+  cd /srv
+  svn co svn://svn.rot13.org/virtual-ldap/
+
+  cd virtual-ldap
+  ./bin/install-debian.sh
+
+
+If you need to augment or mungle LDAP from upstream server start:
+
+  ./bin/ldap-rewrite.pl
+
+To augment data with your own, you should create files
+
+  yaml/uid=login,dc=example,dc=com
+
+
+If you want to expose MySQL Koha database as LDAP server start:
+
+  ./bin/ldap-koha.pl
+
+
+Home page for this program (please register your usage) is:
+
+  https://www.ohloh.net/p/virtual-ldap