Merge pull request #4 from jsager/readme-init

Modified README file to reflect new implementation

Author: Dorthu

README.md

@@ -1,11 +1,41 @@
-# Linode OpenAPI 3 Schema
+# Linode OpenAPI 3
 
-This is the API V4 OpenAPI 3 Schema
+This is the Linode API OpenAPI 3 Schema
+
+## Implementation
+
+We are using [ReDoc](https://github.com/Rebilly/ReDoc) as the front end
+UI for our OpenAPI specification.
+
+Additionally, we are taking advantage of ReDoc's support of
+[Vendor Extensions](https://github.com/Rebilly/ReDoc/blob/master/docs/redoc-vendor-extensions.md)
+such as `x-logo` and `x-code-samples` for extended functionality.
+
+A CSS file has also been added to the html page, to allow customization to the
+output.
+
+## Requirements
+
+Per the [Deployment
+Guidelines](https://github.com/Rebilly/ReDoc#deployment) of the ReDoc
+specification, ReDoc must be installed on the server via yarn or npm.
+
+**yarn:**
+```
+yarn add redoc
+```
+
+**NPM:**
+```
+npm install redoc --save
+```
 
 ## Development
 
-I recommend [Swagger Editor](https://github.com/swagger-api/swagger-editor) for
-development.  You can either download the application, or clone the linked repo
-and run `npm start` to launch it (or use the online version even).  Once in the
-editor, use the File menu to Import the swagger.yaml file in this directory and
-start editing!
+_TODO:_ - We need to finalize the local development portion of this
+repository, so developers can see more than just the OpenAPI spec
+itself.
+
+## Deploy
+
+_TODO:_