From 25d441f2f7343d148c140f8529e5b64f7437fc10 Mon Sep 17 00:00:00 2001 From: Leonardo Barcaroli Date: Mon, 21 Jan 2019 09:32:52 +0100 Subject: [PATCH] README updated --- README.md | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4bfd2d7..ab506e6 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,28 @@ Features -------- * Login/Logout +* Check in/Check out + + +Install +------- + +Either clone this repo and `pip install .` or use one of the provided packages. +Pay attention: this package needs a working binary of [geckodriver](https://github.com/mozilla/geckodriver). +You can either proceed in one of the following ways: + +* Install the source distribution and put in your `$PATH` the `geckodriver` binary + (that can be downloaded [here](https://github.com/mozilla/geckodriver/releases/)) +* Install the wheel for your architecture +* `pip install .` or `pip install -e .` will download the latest `geckodriver` and + put it in a path where the code will be able to find it. + +*BEWARE*: the code gives precedence to the `geckodriver` in `$PATH` over that donwloaded. TODO ---- - * Check in/out - * systemd {unit, timer} - * APIs - * ... + [x] Check in/out + [ ] systemd {unit, timer} + [ ] APIs + [ ] Mailer