add install instructions and usage example to docs

mroethke · mroethke · commit a8a66a9c67a8 · 2016-11-28T15:08:00.000+01:00
diff --git a/README.rst b/README.rst
@@ -1,3 +1,5 @@
+|docs|
+
 =============
 rtrlib-python
 =============
@@ -34,3 +36,8 @@ Requirements
 - six
 
 and a c compiler for building the module.
+
+
+.. |docs| image:: https://readthedocs.org/projects/python-rtrlib/badge/?version=latest
+    :target: http://python-rtrlib.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
diff --git a/docs/conf.py b/docs/conf.py
@@ -34,6 +34,7 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.coverage',
+    'sphinx.ext.viewcode',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,14 +6,66 @@
 Welcome to rtrlib-python's documentation!
 =========================================
 
-rtrlib-python is a cffi based binding for rtrlib_.
+rtrlib-python_ is a cffi based binding for RTRlib_.
+
+The RTRlib implements the client-side of the RPKI-RTR protocol (RFC
+6810) and BGP Prefix Origin Validation (RFC 6811). This release also
+supports Internet-Draft draft-ietf-sidr-rpki-rtr-rfc6810-bis, which
+enables the maintenance of router keys. Router keys are required to
+deploy BGPSEC.
 
 Since this is a work in progress currently only basic validation against one cache is supported.
 
+Installation
+------------
+Requirements
+''''''''''''''
+- python 2.7 or python 3
+- C Compiler
+- RTRlib_
+
+Python Requirements
+'''''''''''''''''''
+If you are using virtualenv these are installed automatically during the install step,
+otherwise you have to use your platforms package management tool or just run ``pip install -r requirements.txt``.
+
+- cffi>=1.4.0
+- enum34
+- six
+
+Download and Installation
+'''''''''''''''''''''''''
+
+- ``git clone https://github.com/rtrlib/python-binding.git``
+- ``cd python-binding``
+- ``python setup.py build``
+- ``python setup.py install``
+
+Example
+-------
+::
+
+    from rtrlib import RTRManager, PfxvState
+
+    mgr = RTRManager('rpki-validator.realmv6.org', 8282)
+    mgr.start()
+    result = mgr.validate(12345, '10.10.0.0', 24)
+
+    if result == PfxvState.valid:
+        print('Prefix Valid')
+    elif result == PfxvState.invalid:
+        print('Prefix Invalid')
+    elif result == PfxvState.not_found:
+        print('Prefix not found')
+    else:
+        print('Invalid response')
+
+
+Further examples can be found in the tools_ dir of the repository.
 
-For usage examples see the tools_ directory on github
 
-.. _rtrlib: https://github.com/rtrlib/rtrlib
+.. _rtrlib-python: https://github.com/rtrlib/python-binding
+.. _RTRlib: https://github.com/rtrlib/rtrlib
 .. _tools: https://github.com/mroethke/rtrlib-python/tree/master/tools
 
 Contents:

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@`
`34`	`34`	`extensions = [`
`35`	`35`	`'sphinx.ext.autodoc',`
`36`	`36`	`'sphinx.ext.coverage',`
	`37`	`+ 'sphinx.ext.viewcode',`
`37`	`38`	`]`
`38`	`39`
`39`	`40`	`# Add any paths that contain templates here, relative to this directory.`