From 10c1f0481719008b34d5339bccdf83788b692f4e Mon Sep 17 00:00:00 2001 From: Cody Hiar Date: Sat, 3 Mar 2018 13:52:46 -0700 Subject: Updating the readme --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index bd30c0a..00cfab0 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,12 @@ https://developers.activecollab.com/api-documentation/v1/people/users/all.html # Getting Started +Install requirements: + +``` +pip install -r requirements.txt +``` + Create a config file: ``` @@ -19,6 +25,13 @@ be set to authenticate against the api. The client_vendor is probably the name of your company. Url is the full url of your active collab instance plus the endpoint of the api e.g `https://activecollab.example.com/api/v1`. +Run the cli + +``` +chmod +x cli.py +./cli.py +``` + # Features - Tab complete on almost every single field. -- cgit v1.2.3