README updated

Leonardo Barcaroli 2019-01-21 09:32:52 +01:00
parent 2dc861fbea
commit 25d441f2f7
1 changed files with 21 additions and 4 deletions

View File

@ -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