update README

Manifest.txt

@@ -1,10 +1,14 @@
 .autotest
 History.txt
 Manifest.txt
-README.txt
+README.rdoc
 Rakefile
 bin/pg_ldap_sync
-config/config.yaml
+config/sample-config.yaml
+config/schema.yaml
 lib/pg_ldap_sync.rb
 lib/pg_ldap_sync/application.rb
+test/fixtures/config-ldapdb.yaml
+test/fixtures/ldapdb.yaml
+test/ldap_server.rb
 test/test_pg_ldap_sync.rb

README.rdoc

@@ -1,25 +1,35 @@
 = Use LDAP permissions in PostgreSQL
 
-* https://github.com/larskanis/pg-ldap-sync
+* Homepage: http://github.com/larskanis/pg-ldap-sync
 
 == DESCRIPTION:
 
-PostgreSQL offers different authentication methods, like LDAP, SSPI, GSSAPI or SSL.
+LDAP is often used to do a centralized user and role management
-For any method the user must already exist in the database, before
+in an enterprise environment. PostgreSQL offers different
-the authentication can be used. LDAP is often used to do a centralized
+authentication methods, like LDAP, SSPI, GSSAPI or SSL.
-user and role management in an enterprise environment.
+However, for any method the user must already exist in the database,
+before the authentication can be used. There is currently
+no authorization of database users directly based on LDAP.
 
-This program synchronizes users, groups and memberships from LDAP to
+This program solves the issue by synchronizing users, groups and
-PostgreSQL.
+memberships from LDAP to PostgreSQL.
+It is meant to be started as a cron job.
 
 == FEATURES/PROBLEMS:
 
-* Use Active Directory as LDAP-Server
 * Configurable per YAML config file
+* Use Active Directory as LDAP-Server
+* Runs with pg.gem (C-library) or postgres-pr.gem (pure Ruby)
+* Should run on any platform when using postgres-pr.gem
+
+* There is currently no way to set certain user attributes in PG
+  based on individual attributes in LDAP
 
 == SYNOPSIS:
 
-  pg_ldap_sync -vv -t
+Create a config file based on <tt>config/sample-config.yaml</tt> .
+
+  pg_ldap_sync -c my_config.yaml -vv -t
 
 == REQUIREMENTS:
 
@@ -33,13 +43,24 @@ Install Ruby and rubygems:
 * <tt>apt-get install ruby rubygems</tt> on Debian
 
 Install pg-ldap-sync and a database driver for PostgreSQL:
-* <tt>gem install pg-ldap-sync postgres-pr</tt>
+* <tt>gem install pg-ldap-sync pg</tt>
+* or <tt>gem install pg-ldap-sync postgres-pr</tt> for the
+  pure ruby version with less connection options than <tt>pg</tt>
 
 Or install from Git:
   git clone https://github.com/larskanis/pg-ldap-sync.git
   cd pg-ldap-sync
   rake install_gem
 
+== TEST:
+There is a small test suite in the <tt>test</tt> directory that runs
+against an internal ruby-ldapserver and PostgreSQL server. Ensure gem
+<tt>ruby-ldapserver</tt> is installed and <tt>pg_ctl</tt>, <tt>initdb</tt> and <tt>psql</tt>
+commands are in the <tt>PATH</tt>. Then:
+
+  cd pg-ldap-sync
+  rake test
+
 
 == LICENSE:
 

Rakefile

@@ -8,6 +8,10 @@ Hoe.spec 'pg-ldap-sync' do
 
   extra_deps << ['net-ldap', '>= 0.2']
   extra_deps << ['kwalify', '>= 0.7']
+
+  self.readme_file = 'README.rdoc'
+  spec_extras[:rdoc_options] = ['--main', readme_file, "--charset=UTF-8"]
+  self.extra_rdoc_files << self.readme_file
 end
 
 # vim: syntax=ruby