From f77f7188d1a4bddaee6d75b9e642fc9a517d03df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rapha=C3=ABl=20Vinot?= Date: Wed, 26 Jun 2019 17:38:07 +0200 Subject: [PATCH] chg: Add documentation for API --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 647c493..3c6d395 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,20 @@ The two core dependencies of this project are the following: * [ETE Toolkit](http://etetoolkit.org/): A Python framework for the analysis and visualization of trees. * [Splash](https://splash.readthedocs.io/en/stable/): Lightweight, scriptable browser as a service with an HTTP API +# Python client + +```bash +$ pip install git+https://github.com/CIRCL/lookyloo.git/#egg=pylookyloo\&subdirectory=client +$ lookyloo --help +usage: lookyloo [-h] [--url URL] --query QUERY + +Enqueue a URL on Lookyloo + +optional arguments: + -h, --help show this help message and exit + --url URL URL of the instance. + --query QUERY URL to unqueue +``` # Installation