Upped version numbers, cleaned up code, fixed my name.

[dbsrgits/SQL-Translator.git] / README

diff --git a/README b/README
index cf4051b..edc834d 100644 (file)
--- a/README
+++ b/README
@@ -7,8 +7,8 @@ MySQL-to-Oracle), visualizations of schemas (pseudo-ER diagrams
 GraphViz or GD), automatic code generation (using Class::DBI),
 converting non-RDBMS files to SQL schemas (xSV text files, Excel
 spreadsheets), serializing parsed schemas (via Storable, YAML and
-XML), creating documentation (HTML and POD), and more.  New to version
-0.03 is the ability to talk directly to a database through DBI to
+XML), creating documentation (HTML and POD), and more.  We also
+have the ability to talk directly to a database through DBI to
 query for the structures of several databases.
 
 Through the separation of the code into parsers and producers with an
@@ -18,19 +18,25 @@ parsed data via the built-in object model.  Presently only the
 definition parts of SQL are handled (CREATE, ALTER), not the
 manipulation of data (INSERT, UPDATE, DELETE).
 
-As of version 0.03, parsers exist for the following:
+As of version 0.10, parsers exist for the following:
 
     Databases:
-        MySQL
-        Oracle
-        PostgreSQL
-        Sybase
-        SQLite
-
+        Access
+        DB2
+        DBI-DB2
         DBI-MySQL
+        DBI-Oracle
         DBI-PostgreSQL
+        DBI-SQLServer
         DBI-SQLite
         DBI-Sybase
+        MySQL
+        Oracle
+        PostgreSQL
+        SQLServer
+        SQLite
+        Storable
+        Sybase
 
     Other:
         xSV          : arbitrarily delimited text files
@@ -41,20 +47,27 @@ As of version 0.03, parsers exist for the following:
 And the following producers exist:
 
     Databases:
+        DB2
         MySQL
         Oracle
         PostgreSQL
+        SQLServer
         SQLite
+        Storable
         Sybase
     
     Code Generators:
         ClassDBI     : Class::DBI classes
+        Dumper       : create a "mysqldump"-like dumper for database
+        DBIx-Class   : see the DBIx::Class distribution
 
     Documentation:
         Diagram      : quasi-ER diagrams using libgd
         GraphViz     : ER diagrams using GraphViz
         HTML         : HTML documentation of schema
         POD          : Plain Old Documenation of schema
+        Latex        : self-explanatory
+        DiaUml       : ditto
 
     Serialization:
         Storable     : using Perl's Storable module
@@ -68,11 +81,12 @@ Included in this distribution are a few scripts designed to be user
 interfaces for the actual SQL::Translator modules.  In the "bin"
 directory, you will find:
 
-*   sqlt-diagram
-*   sqlt-graph
-*   sqlt-dumper
-*   sqlt
-*   sqlt.cgi
+*   sqlt         : command-line interface for text-to-text translations
+*   sqlt-diagram : interface to Diagram producer
+*   sqlt-diff    : diff two schemas to generate schema mutation file 
+*   sqlt-graph   : interface to GraphViz producer
+*   sqlt-dumper  : create a data dumper script from a schema
+*   sqlt.cgi     : CGI interface for all SQLFairy functions
 
 All scripts not ending in ".cgi" are meant to be run from the command
 line with various switches to control the input and output of the
@@ -94,13 +108,15 @@ manipulate the SQL::Translator::Schema objects.
 
 INSTALLATION
 
-The regular method:
-
     $ perl Makefile.PL
-    $ make
-    $ make test
-    $ su -
-    # make install
+    $ make && make test
+    $ sudo make install
+
+MANUAL
+
+To read the manual:
+
+    $ perldoc SQL::Translator::Manual
 
 COPYRIGHT
 
@@ -135,4 +151,4 @@ mailing lists, etc.:
 
 AUTHORS
 
-See the include AUTHORS file.
+See the included AUTHORS file.