From 71bfeb476672ec89db62a670ccde8edb1ddb2e5a Mon Sep 17 00:00:00 2001
From: Peter Morgan <peter@1080peter.com>
Date: Mon, 30 Dec 2019 20:50:10 -0700
Subject: [PATCH] Updated readme

---
 README.md | 96 +++++++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 86 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 456970b..7c7908c 100644
--- a/README.md
+++ b/README.md
@@ -41,20 +41,96 @@ We are very open to new contributors. If you want to contribute to this project,
 
 # API Reference
 
-`https://github-graphs.com/api/friends/<username>`
+`GET https://github-graphs.com/api/friends/<username>`
 
-- `https://api.github.com/users/<username>`
-- `https://api.github.com/users/<username>/followers`
-- `https://api.github.com/users/<username>/following`
+Fetches `https://api.github.com/users/<username>/followers` [(GitHub Reference)](https://developer.github.com/v3/users/followers/#list-followers-of-a-user) and `https://api.github.com/users/<username>/following` [(GitHub Reference)](https://developer.github.com/v3/users/followers/#list-users-followed-by-another-user) to generate an array of users following `<username>` and that `<username>` follows each with values `login` and `avatar_url`.
 
-`https://github-graphs.com/api/repositories/<username>`
+Example result:
 
-- `https://api.github.com/users/<username>/repos`
+```json
+[
+  {
+    "login": "jrtechs",
+    "avatar_url": "https://avatars1.githubusercontent.com/u/13894625?s=460&v=4"
+  }
+]
+```
+
+---
+
+`GET https://github-graphs.com/api/repositories/<username>`
+
+Fetches `https://api.github.com/users/<username>/repos` and returns an array of the repositories `<username>` owns.
+
+Example result:
+
+```json
+[
+  {
+    "name": "bash_manager",
+    "created_at": "2017-09-27T14:38:01Z",
+    "homepage": "",
+    "description": "Python scripts I use to manage my ssh connections, drive mounts, and other bash related things. ",
+    "language": "Python",
+    "forks": 26,
+    "watchers": 4,
+    "open_issues_count": 7,
+    "license": {
+      "key": "mpl-2.0",
+      "name": "Mozilla Public License 2.0",
+      "spdx_id": "MPL-2.0",
+      "url": "https://api.github.com/licenses/mpl-2.0",
+      "node_id": "MDc6TGljZW5zZTE0"
+    },
+    "html_url": "https://github.com/jrtechs/bash_manager"
+  }
+]
+```
+
+---
 
-`https://github-graphs.com/api/org/users/<username>`
+`GET https://github-graphs.com/api/org/users/<organization_name>`
 
-- `https://api.github.com/orgs/<username>/members`
+Fetches `https://api.github.com/orgs/<organization_name>/members` [(GitHub Reference)](https://developer.github.com/v3/orgs/members/#members-list) to generate an array of users that are in `<organization_name>` each with values `login` and `avatar_url`.
 
-`https://github-graphs.com/api/org/repositories/<username>`
+Example result:
 
-- `https://api.github.com/orgs/<username>/repos`
+```json
+[
+  {
+    "login": "jrtechs",
+    "avatar_url": "https://avatars1.githubusercontent.com/u/13894625?s=460&v=4"
+  }
+]
+```
+
+---
+
+`GET https://github-graphs.com/api/org/repositories/<organization_name>`
+
+Fetches `https://api.github.com/orgs/<organization_name>/repos` [(GitHub Reference)](https://developer.github.com/v3/repos/#list-organization-repositories) to return an array of repositories `<organization_name>` owns.
+
+Example result:
+
+```json
+[
+  {
+    "name": "vue",
+    "created_at": "2013-07-29T03:24:51Z",
+    "homepage": "http://vuejs.org",
+    "description": "🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.",
+    "language": "JavaScript",
+    "forks": 23228,
+    "watchers": 154891,
+    "open_issues_count": 419,
+    "license": {
+      "key": "mit",
+      "name": "MIT License",
+      "spdx_id": "MIT",
+      "url": "https://api.github.com/licenses/mit",
+      "node_id": "MDc6TGljZW5zZTEz"
+    },
+    "html_url": "https://github.com/vuejs/vue"
+  }
+]
+```