--- trunk/README	2005/07/06 11:47:56	29
+++ trunk/README.pod	2005/07/06 16:35:51	33
@@ -1,29 +1,53 @@
-1. pgestraier - search Hyper Estraier indexes from PostgreSQL
+=head1 pgestraier - search Hyper Estraier indexes from PostgreSQL
 
 This package is essentially PostgreSQL C function which calls Hyper Estraier
 API and returns results in user defined format.
 
-2. Why is it written?
+=head1 Why is it written?
 
 Aside from providing single API to query your RDBMS and full text index
 (using any language that has PostgreSQL client libraries), real power is
 hidden in ability to join results from full text index and structured data
 in RDBMS.
 
-3. How to install
+=head1 How to install
 
 Installation should be simple. However, you will have to have following
 software already installed before you try this function:
 
- * PostgreSQL (tested with version 7.4.8) with development libraries
- * Hyper Estraier (tested with versions 0.3.9 and 0.3.10)
+=over
+
+=item *
+
+PostgreSQL (tested with version 7.4.8) with development libraries
+
+=item *
+
+Hyper Estraier (tested with versions 0.3.9 and 0.3.10)
+
+=back
 
 To run tests you will also need:
 
- * working perl installation
- * perl modules DBI, DBD::Pg, Test::More
- * trivia.list.gz from Internet Movie Database in data/ directory
- * database "test" with permissions for current user
+=over
+
+=item *
+
+working perl installation
+
+=item *
+
+perl modules C<DBI>, C<DBD::Pg>, C<Test::More> and optionally C<HyperEstraier>
+
+=item *
+
+C<trivia.list.gz> from Internet Movie Database in data/ directory
+
+=item *
+
+database "test" with permissions for current user
+
+=back
 
 If you have all that, you should be able to type
 
@@ -35,7 +59,7 @@
 
 Next, you will have to create test index. You have two options:
 
-3.1. Create index using estcmd
+=head2 Create index using estcmd
 
 This will create temporary files on disk and index them using estcmd gather
 
@@ -43,11 +67,11 @@
   make index
   cd ..
 
-3.2. Create index using Hyper Estraier perl bindings
+=head2 Create index using Hyper Estraier perl bindings
 
 For this, you will have to install perl bindings from
 
-  http://tokuhirom.dnsalias.org/~tokuhirom/archive/hyper_estraier_wrappers-0.0.6.tar.gz
+L<http://tokuhirom.dnsalias.org/~tokuhirom/archive/hyper_estraier_wrappers-0.0.6.tar.gz>
 
 If you installed bindings as documented in README file, you can issue
 following commands to create index about three times faster than using
@@ -63,7 +87,7 @@
 
 See also included file test.sql for more examples of usage.
 
-4. Who wrote this?
+=head1 Who wrote this?
 
 Hyper Estraier is written by Mikio Hirabayashi.