documentation update

Author: chfw

Diff for: README.rst

@@ -14,9 +14,20 @@ Flask-Excel - Let you focus on data, instead of file formats
 .. image:: http://img.shields.io/gittip/chfw.svg
    :target: https://gratipay.com/chfw/
 
-**Flask-Excel** is based on `pyexcel <https://github.com/chfw/pyexcel>`_ and makes it easy to consume/produce information stored in excel files over HTTP protocol as well as on file system. This library can turn the excel data into a list of lists, a list of records(dictionaries), dictionaries of lists. And vice versa. Hence it lets you focus on data in Flask based web development, instead of file formats.
-
-The idea originated from the problem of the illiteracy of excel file formats of non-technical office workers: such as office assistant, human resource administrator. There is nothing with the un-deniable fact that some people do not know the difference among various excel formats. It becomes usability problem to those people when a web service cannot parse the excel file that they saved using Microsoft Excel. Instead of training those people about file formats, this library helps web developers to handle most of the excel file formats by unifying the programming interface to most of the excel readers and writers.
+**Flask-Excel** is based on `pyexcel <https://github.com/chfw/pyexcel>`_ and makes
+it easy to consume/produce information stored in excel files over HTTP protocol as
+well as on file system. This library can turn the excel data into a list of lists,
+a list of records(dictionaries), dictionaries of lists. And vice versa. Hence it
+lets you focus on data in Flask based web development, instead of file formats.
+
+The idea originated from the problem of the illiteracy of excel file formats of
+non-technical office workers: such as office assistant, human resource administrator.
+There is nothing with the un-deniable fact that some people do not know the
+difference among various excel formats. It becomes usability problem to those
+people when a web service cannot parse the excel file that they saved using
+Microsoft Excel. Instead of training those people about file formats, this library
+helps web developers to handle most of the excel file formats by unifying the
+programming interface to most of the excel readers and writers.
 
 The highlighted features are:
 
@@ -28,14 +39,16 @@ The highlighted features are:
 Available Plugins
 =================
 
-================ ========================================================================
-Plugins          Supported file formats                                      
-================ ========================================================================
+================ ==========================================
+Plugins          Supported file formats                    
+================ ==========================================
 `pyexcel-xls`_   xls, xlsx(r), xlsm(r)
 `pyexcel-xlsx`_  xlsx
-`pyexcel-ods`_   ods (python 2.6, 2.7)                                       
-`pyexcel-ods3`_  ods (python 2.7, 3.3, 3.4)                                  
-================ ========================================================================
+`pyexcel-ods`_   ods (python 2.6, 2.7)                     
+`pyexcel-ods3`_  ods (python 2.7, 3.3, 3.4)                
+`text`_          write only)json, rst, mediawiki,
+                 latex, grid, pipe, orgtbl, plain simple
+================ ==========================================
 
 .. _pyexcel-xls: https://github.com/chfw/pyexcel-xls
 .. _pyexcel-xlsx: https://github.com/chfw/pyexcel-xlsx

Diff for: doc/source/index.rst

@@ -44,7 +44,35 @@ The highlighted features are:
 .. _ods3: https://github.com/chfw/pyexcel-ods3
 .. _text: https://github.com/chfw/pyexcel-text
 
-This library makes infomation processing involving various excel files as easy as processing array, dictionary when processing file upload/download, data import into and export from SQL databases, information analysis and persistence. It uses **pyexcel** and its plugins: 1) to provide one uniform programming interface to handle csv, tsv, xls, xlsx, xlsm and ods formats. 2) to provide one-stop utility to import the data in uploaded file into a database and to export tables in a database as excel files for file download 3) to provide the same interface for information persistence at server side: saving a uploaded excel file to and loading a saved excel file from file system.
+This library makes infomation processing involving various excel files as easy as processing array and dictionary. The information processing job includes when processing file upload/download, data import into and export from SQL databases, information analysis and persistence. It uses **pyexcel** and its plugins: 1) to provide one uniform programming interface to handle csv, tsv, xls, xlsx, xlsm and ods formats. 2) to provide one-stop utility to import the data in uploaded file into a database and to export tables in a database as excel files for file download 3) to provide the same interface for information persistence at server side: saving a uploaded excel file to and loading a saved excel file from file system.
+
+Installation
+-------------------
+
+You can install it via pip::
+
+    $ pip install Flask-Excel
+
+
+or clone it and install it::
+
+    $ git clone http://github.com/chfw/Flask-Excel.git
+    $ cd Flask-Excel
+    $ python setup.py install
+
+Installation of individual plugins , please refer to individual plugin page.
+
+Setup
+------------------------
+
+In your application, you must import it before using it::
+
+    from flask.ext import excel
+
+or::
+
+    import flask.ext.excel
+    
 
 Quick start
 ------------