Add installation instructions to readme

ECN · Mar 18, 2021 · 07ee438 · 07ee438
1 parent 52061e8
commit 07ee438
Showing 1 changed file with 21 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,21 @@
-# webqueue2-api
+# webqueue2 API
+A Python based parser and RESTful API for ECN's webqueue.
+
+## Usage
+### Install via pip:
+```
+pip install git+https://github.itap.purdue.edu/ECN/webqueue2-api@<VERSION>#egg=webqueue2-api
+```
+For example, to install version 0.9.1:
+```
+pip install git+https://github.itap.purdue.edu/ECN/webqueue2-api@0.9.1#egg=webqueue2-api
+```
+
+### Install via requirements file:
+```
+git+https://github.itap.purdue.edu/ECN/webqueue2-api@<VERSION>#egg=webqueue2-api
+```
+For example, to install version 0.9.1:
+```
+git+https://github.itap.purdue.edu/ECN/webqueue2-api@0.9.1#egg=webqueue2-api
+```