From 07ee438cf81810c31c3f17351c721f8ddbac64f5 Mon Sep 17 00:00:00 2001 From: "Bennett, Jacob Daniel" Date: Fri, 12 Mar 2021 02:27:01 -0500 Subject: [PATCH] Add installation instructions to readme --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c4ded76..a168600 100644 --- a/README.md +++ b/README.md @@ -1 +1,21 @@ -# webqueue2-api \ No newline at end of file +# 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@#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@#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 +```