ECN · campb303 · Jun 21, 2021 · Feb 22, 2021 · Mar 12, 2021 · Mar 12, 2021
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
+```
diff --git a/__init__.py b/__init__.py
diff --git a/api.py b/api.py
diff --git a/docstring-format.mustache b/docstring-format.mustache
@@ -0,0 +1,38 @@
+{{! Google Docstring Template }}
+{{summaryPlaceholder}}
+
+{{extendedSummaryPlaceholder}}
+
+Example:
+        [example]
+
+{{#parametersExist}}
+Args:
+{{#args}}
+        {{var}} ({{typePlaceholder}}): {{descriptionPlaceholder}}
+{{/args}}
+{{#kwargs}}
+        {{var}} ({{typePlaceholder}}, optional): {{descriptionPlaceholder}}. Defaults to {{&default}}.
+{{/kwargs}}
+{{/parametersExist}}
+
+{{#exceptionsExist}}
+Raises:
+{{#exceptions}}
+        {{type}}: {{descriptionPlaceholder}}
+{{/exceptions}}
+{{/exceptionsExist}}
+
+{{#returnsExist}}
+Returns:
+{{#returns}}
+        {{typePlaceholder}}: {{descriptionPlaceholder}}
+{{/returns}}
+{{/returnsExist}}
+
+{{#yieldsExist}}
+Yields:
+{{#yields}}
+        {{typePlaceholder}}: {{descriptionPlaceholder}}
+{{/yields}}
+{{/yieldsExist}}