X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=docs%2Findex.rst;h=84f0dd31e7247e9b4e3b45e3cd03870ac8426b5c;hb=6d0a03d91697c78a14b7ef31aa71b47b400fbb4b;hp=356f1d124872edffef16db48578a1a497ff03764;hpb=897abc011d161bbb285e7d7c0cea4c2bf934ece4;p=sqlconvert.git

diff --git a/docs/index.rst b/docs/index.rst
index 356f1d1..84f0dd3 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,47 +1,26 @@
-.. 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.
 
-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 [infile] [[-o] outfile]
-
-Options::
-
-    infile                 Input file, stdin if absent or '-'
-    -o, --outfile outfile  Output file, stdout if absent or '-'
-
-Option `-o` is useful when infile is absent (input is redirected), for
-example::
-
-    mysql-to-sql.py -o outfile.sql < infile.sql
-    cat infile.sql | mysql-to-sql.py -o outfile.sql
-
-But of course it simple can be::
-
-    mysql-to-sql.py - outfile.sql < infile.sql
-    cat infile.sql | mysql-to-sql.py - outfile.sql
+   mysql2sql
 
 
 Indices and tables