From d61fee7ba331bf3c6c891e8316b0e936729ada11 Mon Sep 17 00:00:00 2001 From: Zoe Roux Date: Sat, 14 Nov 2020 01:18:50 +0100 Subject: [PATCH] Update README.md --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 16390e5..6194f41 100644 --- a/README.md +++ b/README.md @@ -55,3 +55,23 @@ You can add interceptors to your coordinator. An interceptor is a function that ### The default handler A `default_handler` method can be specified in your coordinator. This special method will be called once the whole pipeline has been consumed but no Output has been returned. You can also use this method instead of the `pipeline` property by removing the property from your coordinator (or returning an empty list). + +## Usage +``` +usage: autopipe [-h] [-V] [-v [loglevel]] [-d] coordinator [coordinator ...] + +Easily run advanced pipelines in a daemon or in one run sessions. + +positional arguments: + coordinator The name of your pipeline coordinator. + +optional arguments: + -h, --help show this help message and exit + -V, --version show program's version number and exit + -v [loglevel], --verbose [loglevel] + Set the logging level. + -d, --daemon Enable the daemon mode (rerun input generators after a sleep cooldown) +``` + +## Instalation +For now, no pip package exist for this project. Simply clone the project and run ``pipenv install`` (you will need pipenv for that: ``sudo pip install pipenv``).