X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=docs%2Findex.rst;h=d81db53cf40a2f8001a0205600cdef7b832d716c;hb=5d3f6b303b6843067972d980ca522e6284e1c003;hp=e9c3631699c7b36bb1f52cdb9744167139f1b479;hpb=366adfd33e858aabc683f973bc1b2a08c2f5e58f;p=sqlconvert.git

diff --git a/docs/index.rst b/docs/index.rst
index e9c3631..d81db53 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,36 +1,27 @@
-.. mysql2sql documentation master file, created by
+.. sqlconvert documentation master file, created by
    sphinx-quickstart on Fri Jul 22 19:32:24 2016.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to mysql2sql's documentation!
+Welcome to sqlconvert's documentation!
 =====================================
 
-This is mysql2sql, a mysql to sql converter. It is primary intended to
-convert mysqldump (especially with extended INSERT syntax) to standard
-SQL to load at least to PostgreSQL or SQLite.
+This is sqlconvert, a library to implement SQL converters. It uses `sqlparse
+<https://github.com/andialbrecht/sqlparse>`_ to parse SQL and `SQLObject
+<http://sqlobject.org/>`_ to escape SQL strings and handle connections.
 
-It uses `sqlparse <https://github.com/andialbrecht/sqlparse>`_ to parse
-SQL.
+The library is in the early stage of development and currently cannot do much.
 
-The program is in its initial phase and currently cannot do much.
+The first goal is to implement `mysql2sql <mysql2sql.html>`_, a script intended
+primarily to convert mysqldump (especially with extended INSERT syntax) to
+standard SQL to load at least to PostgreSQL or SQLite.
 
-.. highlight:: none
+Contents:
 
-Command line
-------------
+.. toctree::
+   :maxdepth: 1
 
-mysql-to-sql.py
-~~~~~~~~~~~~~~~
-
-Usage::
-
-    mysql-to-sql.py [-i infile] [-o outfile]
-
-Options::
-
-    -i, --infile infile    Input file, stdin if absent
-    -o, --outfile outfile  Output file, stdout if absent
+   mysql2sql
 
 
 Indices and tables