finish documentation

Author: Windfarer

README.md

@@ -5,30 +5,64 @@ Simple and fast MySQL to Elasticsearch sync tool, written in Python3.
 This tool helps you to initialize MySQL dump table to Elasticsearch by parsing mysqldump, then incremental sync MySQL table to Elasticsearch by processing MySQL Binlog.
 
 ## Installation
+By following these steps.
+##### 1. Python
 This tool is written in Python3.4, so you must install Python3.4 first, by following [this guide](https://docs.python.org/3.4/using/index.html)
+##### 2. ibxml2 and libxslt
+Also, this tool depends on python lxml package, so that you should install  the lxml's dependecies correctly, the libxml2 and libxslt are required.
 
-Also, this tool depends on python lxml package, in which you should install it correctly. (Attention, the lxml needs )
-See [lxml Installation](http://lxml.de/installation.html) 
+For example, in CentOS:
 
+```
+sudo yum install libxml2 libxml2-devel libxslt libxslt-devel
+```
+
+or in Debian/Ubuntu:
+
+```
+sudo apt-get install libxml2-dev libxslt-dev python-dev
+```
+
+See [lxml Installation](http://lxml.de/installation.html) for more infomation.
+##### 3. mysqldump
+And then, mysqldump is required.
+
+
+##### 4. this tool
 Then clone this repo and install dependencies
 
 ```
 git clone https://github.com/zhongbiaodev/py-mysql-elasticsearch-sync.git 
 
 cd py-mysql-elasticsearch-sync
 
-pip install -r requirements.txt
+pip3 install -r requirements.txt
 ```
 
 ## Configuration
-TODO
+There is a [sample config](https://github.com/zhongbiaodev/py-mysql-elasticsearch-sync/blob/master/sample.yaml) file in repo, you can start by editing it.
+
+## Running
+Simply run command
+
+```
+python3 main.py path/to/your/config.yaml
+```
+and the tool will dump your data as stream to sync, when dump is over, it will start to sync binlog.
+
+the latest synced binlog file and position are recorded in your info file which is configured in your config file. You can restart dump step by remove it, or you can change sync position by edit it.
+
+Or if you  but want to load it from your own dumpfile. You should dump your table first as xml format(by adding ```-X```option to your mysqldump command) 
+
+then
+```python3 main.py path/to/your/config.yaml --fromfile```
+to start sync, when xml sync is over, it will also start binlog sync.
 
-## Deployment and Running
-TODO
+## Deploying
+We provide an upstart script to help you deploy this tool, you can edit it for your own condition, besides, you can deploy it in your own way.
 
 
 ## TODO
-- [ ]  Documentation
 - [ ]  Packaging
 - [ ]  MultiIndex Supporting
 

main.py

@@ -349,7 +349,7 @@ def main():
     """
     try:
         if not log_file and not log_pos:
-            if len(sys.argv) > 2 and sys.argv[2] == 'fromfile':
+            if len(sys.argv) > 2 and sys.argv[2] == '--fromfile':
                 sync_from_file()
             else:
                 sync_from_stream()