Improve the docs.

2 files changed, 30 insertions, 3 deletions

diff --git a/docs/source/conf.py b/docs/source/conf.py
index 473bd55..f6bbfa6 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -52,8 +52,8 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'VyMGMT'
-copyright = u'2016, Hochikong'
-author = u'Hochikong'
+copyright = u'2016, VyOS Team, Hochikong'
+author = u'VyOS Team, Hochikong'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -122,7 +122,7 @@ todo_include_todos = False
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'classic'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
diff --git a/docs/source/index.rst b/docs/source/index.rst
index e24228f..a82e98e 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -20,3 +20,30 @@ Indices and tables
 * :ref:`modindex`
 * :ref:`search`
 
+Quick introduction
+==================
+
+A python library for executing commands on VyOS systems.
+
+Generic methods should also work with any of the Vyatta descendants (EdgeOS, Brocade vRouter).
+
+The library is compatible with both python2 and python3.
+
+It is released under the MIT license.
+
+Usage example::
+
+    import vymgmt
+
+    vyos = vymgmt.Router('192.0.2.1', 'vyos', password='vyos', port=22)
+
+    vyos.login()
+    vyos.configure()
+
+    vyos.set("protocols static route 203.0.113.0/25 next-hop 192.0.2.20")
+    vyos.delete("system options reboot-on-panic")
+
+    vyos.commit()
+    vyos.save()
+    vyos.exit()
+    vyos.logout()