setup.py: add long description

README.rst

@@ -55,3 +55,33 @@ ldapsync
           --fake                compute synchronization actions but do not apply
           --verbose             print all actions to stdout
 
+Exemple
+-------
+
+Synchronize tree of organizational units and people between an LDIF file and a local OpenLDAP directory::
+
+        ldapsync --attributes 'uid cn givenName sn dc ou o description mail member' \
+                 --object-class-pivot 'inetOrgPerson uid' \
+                 --object-class-pivot 'organizationalUnit ou' \
+                 --object-class-pivot 'dcobject dc' \
+                 --source-uri dump.ldif \
+                 --source-base-dn dc=myorganization,dc=fr \
+                 --target-uri ldapi:// \
+                 --target-base-dn o=myorganization,dc=otherorganization,dc=fr \
+                 --verbose
+
+Synchronize tree of organizational units and people between two LDAP directories::
+
+        ldapsync --attributes 'uid cn givenName sn dc ou o description mail member' \
+                 --object-class-pivot 'inetOrgPerson uid' \
+                 --object-class-pivot 'organizationalUnit ou' \
+                 --object-class-pivot 'dcobject dc' \
+                 --source-uri ldap://ldap.myorganization.fr \
+                 --source-bind-dn uid=admin,ou=people,dc=myorganization,dc=fr
+                 --source-bind-password password
+                 --source-base-dn dc=myorganization,dc=fr \
+                 --target-uri ldap://ldap.otherorganization.fr
+                 --target-bind-dn uid=admin,o=myorganization,dc=otherorganization,dc=fr
+                 --target-bind-password password
+                 --target-base-dn o=myorganization,dc=otherorganization,dc=fr \
+                 --verbose

setup.py

@@ -50,6 +50,7 @@ setup(name="ldaptools",
       version=get_version(),
       license="AGPLv3+",
       description="ldaptools",
+      long_description=open('README.rst').read(),
       url="http://dev.entrouvert.org/projects/ldaptools/",
       author="Entr'ouvert",
       author_email="authentic@listes.entrouvert.com",