From 1d0b446add9c275510a2a8164568b9df3a7c9209 Mon Sep 17 00:00:00 2001
From: Daniil Baturin <daniil@baturin.org>
Date: Tue, 6 Sep 2016 13:17:51 +0600
Subject: Improve the docs.

---
 docs/source/index.rst | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

(limited to 'docs/source/index.rst')

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()
-- 
cgit v1.2.3