From fc6cff1dca051d9ac036e1d5f01ffca9c5262f6b Mon Sep 17 00:00:00 2001
From: Anson <anson@ansonbiggs.com>
Date: Thu, 23 Apr 2020 21:17:23 -0700
Subject: [PATCH] added a helpful readme

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/README.md b/README.md
index 46fe7c7..604a10f 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,33 @@
 # 2 Chainz Rest
 
+API for 2 Chainz quotes an aliases built using Python and Azure Functions. More project info at [2.chainz.rest](https://2.chainz.rest).
+
+## Endpoints
+
+### Quote
+
+Returns a random 2 Chainz Quote in `json` format like the following example:
+
+send a `get` request to `https://api.chainz.rest/quote`
+
+```json
+{
+  "quote": "I got a pocket full of money, it got me walking all slew-foot"
+}
+```
+
+[Source Code](quote/__init__.py)
+
+### Alias
+
+Returns a random 2 Chainz alias in `json` format. The return values are weighted and a full list can be seen in [aliases.py](alias/aliases.py).
+
+send a `get` request to `https://api.chainz.rest/alias`
+
+```json
+{
+  "alias": "Dos Cadenas"
+}
+```
+
+[Source Code](alias/__init__.py)