From 9e15ccd53a40600ff662b3c3ef39a69c0c88070b Mon Sep 17 00:00:00 2001
From: Kat Gill <109633947+Thatskat@users.noreply.github.com>
Date: Fri, 30 Jun 2023 15:34:30 +1000
Subject: [PATCH] finished initial read me documentation

---
 README.md | 56 ++++++++++++++++++++++++++++++++-----------------------
 1 file changed, 33 insertions(+), 23 deletions(-)

diff --git a/README.md b/README.md
index 411634b..d1317c7 100644
--- a/README.md
+++ b/README.md
@@ -1,23 +1,32 @@
-<img src='https://github.com/Thatskat/southpark-quotes-api/blob/main/public/imgs/Southpark-api.jpg' alt='South Aprk API Header'/>
+![](https://github.com/Thatskat/southpark-quotes-api/blob/main/public/imgs/southpark-api-header.svg)
+
+
+
+<h1 align='center'> South Park Quotes API</h1>
+
 
-<h1 align='center'>South Park Quotes API</h1>
 <p align='center'>A pretty simple API to let you retrieve some of the best quotes from South Park, mmkay!</p>
 &nbsp;
-<div align='center' id='githubStats'>
- <img src='https://img.shields.io/github/forks/Thatskat/southpark-quotes-api?label=Forks&style=for-the-badge&color=%23bbf7d0' alt='Southpark API Forks'/>&nbsp;
- <img src='https://img.shields.io/github/stars/Thatskat/southpark-quotes-api?style=for-the-badge&color=%23bbf7d0' alt='Southpark API Stars'/>&nbsp;
- <img src='https://img.shields.io/github/issues-pr/Thatskat/southpark-quotes-api?style=for-the-badge&color=%23bbf7d0' alt='Southpark API Pull Requests'/>
+<div align='center'>
+ <img src='https://img.shields.io/github/forks/Thatskat/southpark-quotes-api?label=Forks&style=for-the-badge&color=%23bbf7d0' alt='South Park Quotes API Forks'/>&nbsp;
+ <img src='https://img.shields.io/github/stars/Thatskat/southpark-quotes-api?style=for-the-badge&color=%23bbf7d0' alt='South Park Quotes API Stars'/>&nbsp;
+ <img src='https://img.shields.io/github/issues-pr/Thatskat/southpark-quotes-api?style=for-the-badge&color=%23bbf7d0' alt='South Park Quotes API Pull Requests'/>
 </div>
-&nbsp;
-<h2>Production Host</h2>
-🌐 <a href='https://southparkquotes.up.railway.app/'>https://southparkquotes.up.railway.app/</a>
-&nbsp;
 
-<h2>API</h2>
-<h3><b>GET /v1/quotes</b></h3>
-<p>Get a random quote:</p>
-<a href='https://southparkquotes.up.railway.app/v1/quotes'>https://southparkquotes.up.railway.app/v1/quotes</a>
-&nbsp;
+
+## Production Host
+
+🌐 [https://southparkquotes.up.railway.app/](https://southparkquotes.up.railway.app/)
+
+
+## API
+
+
+### `GET /v1/quotes`
+Get a random quote:
+
+> [https://southparkquotes.up.railway.app/v1/quotes](https://southparkquotes.up.railway.app/v1/quotes)
+
 
 ```
 [
@@ -29,10 +38,11 @@
 ```
 
 
-<h3><b>GET /v1/quotes/{number}</b></h3>
-<p>Returns an array of {number} of South Park quotes. E.g. GET /v1/quotes/3 :</p>
-<a href='https://southparkquotes.up.railway.app/v1/quotes/3'>https://southparkquotes.up.railway.app/v1/quotes/3</a>
-&nbsp;
+### `GET /v1/quotes/{number}`
+Returns an array of `{number}` South Park quotes. E.g. `GET /v1/quotes/3`
+
+> [https://southparkquotes.up.railway.app/v1/quotes/3](https://southparkquotes.up.railway.app/v1/quotes/3)
+
 
 ```
 [
@@ -51,8 +61,8 @@
 ]
 ```
 
-<h2>Contribution</h2>
-<p>Want to add some South Park quotes? All you need to do is simply add them in the quotes.js file and then create a pull request.</p>
+## Contributions
+Want to add some South Park quotes? All you need to do is simply add them in the quotes.js file and then create a pull request.
 
-<h2>Credits</h2>
-<p>This quotes API was greatly inspired by <a href='https://github.com/shevabam/breaking-bad-quotes'>Breaking Bad Quotes</a> and <a href='https://github.com/jamesseanwright/ron-swanson-quotes'>Ron Swnson Quotes</a>.</p>
+## Credits
+This quotes API was greatly inspired by [Breaking Bad Quotes](https://github.com/shevabam/breaking-bad-quotes) and [Ron Swnson Quotes](https://github.com/jamesseanwright/ron-swanson-quotes).