Rename mysql2sql -> sqlconvert

[sqlconvert.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index e9c3631699c7b36bb1f52cdb9744167139f1b479..46e6c4592324f04f88b8327e118745759792b220 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,36 +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.
-
-It uses `sqlparse <https://github.com/andialbrecht/sqlparse>`_ to parse
-SQL.
+This is sqlconvert, a library to implenet SQL converters. It uses `sqlparse
+<https://github.com/andialbrecht/sqlparse>`_ to parse SQL.
 
 The program is in its initial phase and currently cannot do much.
 
-.. highlight:: none
-
-Command line
-------------
-
-mysql-to-sql.py
-~~~~~~~~~~~~~~~
-
-Usage::
+The first goal is to implemet `mysq2sql <mysq2sql.html>`_, a script intended
+primarily to convert mysqldump (especially with extended INSERT syntax) to
+standard SQL to load at least to PostgreSQL or SQLite.
 
-    mysql-to-sql.py [-i infile] [-o outfile]
+Contents:
 
-Options::
+.. toctree::
+   :maxdepth: 2
 
-    -i, --infile infile    Input file, stdin if absent
-    -o, --outfile outfile  Output file, stdout if absent
+   mysq2sql
 
 
 Indices and tables