aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCody Hiar <codyfh@gmail.com>2018-03-03 13:52:46 -0700
committerCody Hiar <codyfh@gmail.com>2018-03-03 13:52:46 -0700
commit10c1f0481719008b34d5339bccdf83788b692f4e (patch)
tree961cf200b22daf02dca8a43a417771104c808539
parent6ffecd93bc287d3654474fc6c834118c90c5cdc6 (diff)
Updating the readme
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
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.