Readme updates

README.md

@@ -4,12 +4,34 @@
      (\
     (  \  /(o)\
     (   \/  ()/ /)
-     (   `;.))'".) 
+     (   `;.))'".)
       `(/////.-'
-   =====))=))===() 
-     ///'       
+   =====))=))===()
+     ///'
     //   PjP/ejm
-   '            
+   '
 ```
 
-Parrot is a poeditor pull-through cache.
+Parrot the [POEditor](http://poeditor.com/) pull-through cache.
+
+This cache makes it possible to pull app translations directly from [POEditor](http://poeditor.com/) instead of compiling them into your app. This means no more re-builds every time translations are updated!
+
+# Features
+
+-   **Cache choices**: Parrot support comes with a Filesystem and Redis cache choice to facilitate single app deployment and highly distributed deployments.
+-   **OpenAPI**: The Parrot API has been documented in OpenAPI specification which can be found in the [doc/](/docs) directory.
+-   _..._
+
+# Deployment
+
+_TODO_
+
+# API
+
+The REST API of Parrot is documented in the OpenAPI format. The specification file can be found here [docs/api.yml](docs/api.yml) and a Swagger UI is available here [uniwise.github.io/parrot](https://uniwise.github.io/parrot).
+
+# License
+
+Parrot is available under the Apache 2 license.
+
+This project uses open source components which have additional licensing terms.

docs/index.html

@@ -17,7 +17,7 @@
     <script>
       window.onload = function () {
         const ui = SwaggerUIBundle({
-          url: "swagger.yml",
+          url: "api.yml",
           dom_id: "#openapi"
         });
       }