From 6b2c2e5a245f204f9cb23b9aae653fe66386cfb9 Mon Sep 17 00:00:00 2001
From: Lucidiot <lucidiot@protonmail.com>
Date: Sat, 20 Oct 2018 19:03:58 +0200
Subject: [PATCH] Add some docs

---
 README.md            | 32 ++++++++++++++++++++++++++++++++
 requirements-dev.txt |  1 +
 2 files changed, 33 insertions(+)

diff --git a/README.md b/README.md
index 137a371..11fc780 100644
--- a/README.md
+++ b/README.md
@@ -15,3 +15,35 @@ creating better tracking interfaces.
 ## Requirements
 
 This package just needs [requests](https://python-requests.org). That's it.
+
+## Scripts
+
+This package provides a simple tracker script, `urbantz.tracker`, that can be
+invoked like this:
+
+``` bash
+python -m urbantz.tracker <ID> [-f|--freq <seconds>]
+```
+
+The script will perform a request every 10 seconds (by default) to the
+UrbanTZ API, then print the current date, time, and distance between the
+delivery truck and the destination.
+
+## Development
+
+### Setup
+
+Sample setup using
+[`virtualenvwrapper`](https://virtualenvwrapper.readthedocs.io/):
+
+```
+mkvirtualenv pyurbantz -a .
+pip install -r requirements-dev.txt
+pip install -e .
+```
+
+### Linting
+
+The source code follows the PEP 8 code style and performs CI checks using the
+`flake8` tool. To perform the same checks locally, run `flake8` on the root
+directory of this repository.
diff --git a/requirements-dev.txt b/requirements-dev.txt
index d9fbead..eb04a73 100644
--- a/requirements-dev.txt
+++ b/requirements-dev.txt
@@ -1 +1,2 @@
+-r requirements.txt
 flake8>=3.5