From 725b138e8b04964a42c2dbcbaeb9afb65a903d4c Mon Sep 17 00:00:00 2001
From: "Fanani M. Ihsan" <fanani.mi@gmail.com>
Date: Fri, 27 May 2016 01:27:43 +0700
Subject: [PATCH] update sphinx docs

---
 docs/index.rst | 65 ++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 61 insertions(+), 4 deletions(-)

diff --git a/docs/index.rst b/docs/index.rst
index 4dc38ed..0331934 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,18 +3,75 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+********************************
 Welcome to pyzk's documentation!
-================================
+********************************
 
-Contents:
+pyzk is unofficial library for zksoftware the fingerprint attendance machine. It's easy to use and no need to understand how to communicate to device. Just create ZK instance and you will ready to use api.
+
+Installation
+############
+
+You can install from two different options
+
+1. from pypi
+
+  ``$ pip install pyzk``
+
+
+2. from original repository
+
+Go to https://github.com/fananimi/pyzk and clone the latest source code by using git, and then just execute the setup.py file.
+
+
+ ``$ python setup.py install``
+
+
+Basic Usage
+###########
+
+.. code-block:: python
+
+    import zk
+    from zk import const
+
+    zk = zk.ZK(ip='192.168.1.201', port=4370, timeout=5)
+    try:
+        zk.connect()
+        # disable (lock) the device, make sure no activity when process run
+        zk.disable_device()
+
+        # Do another task here
+        firmware = zk.get_firmware_version()
+        print 'Firmware Version: : {}'.format(firmware.get('data'))
+        users = zk.get_users()
+        if users.get('status'):
+            for user in users.get('data'):
+                privilege = 'User'
+                if user.privilege == const.USER_ADMIN:
+                    privilege = 'Admin'
+
+                print '- UID #{}'.format(user.uid)
+                print '  Name       : {}'.format(user.name)
+                print '  Privilege  : {}'.format(privilege)
+                print '  Password   : {}'.format(user.password)
+                print '  Group ID   : {}'.format(user.group_id)
+                print '  User  ID   : {}'.format(user.user_id)
+
+        # don't forget to re-enable device
+        zk.enable_device()
+    except Exception, e:
+        print "Process terminate : {}".format(e)
+    finally:
+        if zk.is_connect:
+            zk.disconnect()
 
 .. toctree::
    :maxdepth: 2
 
 
-
 Indices and tables
-==================
+##################
 
 * :ref:`genindex`
 * :ref:`modindex`