From 6cab1800bb1a00383e3ffe5b4044725f4410cbdf Mon Sep 17 00:00:00 2001 From: Alexandre Dulaunoy Date: Wed, 29 Oct 2014 10:45:18 +0100 Subject: [PATCH] Documentation reference added --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 31b3fd8..a28ec84 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,9 @@ -Python API for MISP using the REST interface of the application via requests. +PyMISP is a Python library to access [MISP](https://github.com/MISP/MISP) platforms via their REST API. + +Requirements +------------ + + * [requests](http://docs.python-requests.org) Install ------- @@ -8,4 +13,15 @@ python setup.py install Example ------- -An example is available in examples/ +An example to copy events between MISP instances is included in examples/ + +Documentation +------------- + +[PyMISP API documentation is available](http://www.circl.lu/assets/files/PyMISP.pdf). + +Documentation can be generated with epydoc: + +~~~~ + epydoc --url https://github.com/CIRCL/PyMISP --graph all --name PyMISP --pdf pymisp -o doc +~~~~