Add documentation and copyrights

1 files changed, 37 insertions, 1 deletions

diff --git a/README b/README
index d1d8a13..c9bdcc0 100644
--- a/README
+++ b/README
@@ -1,3 +1,39 @@
 =================================================================
-                   SLAPI-DNSNOTIFY 0.1 README
+                     SLAPI-DNSNOTIFY README
 
+More information is available here:
+
+        http://memberwebs.com/stef/software/slapi-dnsnotify/
+
+This is a SLAPI 'postoperation' plugin. The entry point is 'plugin_init'.
+See below for an example of how to configure it.
+
+An LDAP entry is assumed to be a zone if it has an sOARecord attribute.
+The exact name of the attribute can be controlled with the soa-attribute
+option. The information about the zone, such as name servers and zone
+name are retrieved from the same LDAP entry, that is the one with the SOA
+attribute on it.
+
+Notification requests are handled by the notify-dns-slaves(5) tool. The
+notifications are not sent immediately, and multiple notifications that
+occur close together are combined into a single notification. See the
+notify-delay option.
+
+To increment the serial number of a zone automatically whenever something
+in the zone changes, use the enable-auto-serial option. All LDAP entries
+beneath the entry with the SOA attribute are assumed to be part of that
+zone for purposes of incrementing the serial number.
+
+Here is an example of how to configure this plugin with OpenLDAP, using
+an LDAP base DN of dc=example,dc=com and with automatic incrementing of
+the zone serial number and a notification delay of 10 seconds.
+
+The following would go into your slapd.conf(5) file:
+
+      plugin postoperation \
+              /usr/local/lib/slapi-dnsnotify.so plugin_init \
+              notify-delay=10 base-dn=ou=web,dc=ws,dc=local \
+              enable-auto-serial
+
+The above may all be specified on one line. The backslashes at the end
+make it more readable and maintainable.