From 97a388726c132f2a8059fc89061c3bcf1d4f8de8 Mon Sep 17 00:00:00 2001
From: Mac <mohammed.ali.chherawalla@gmail.com>
Date: Mon, 30 May 2022 13:17:23 +0530
Subject: [PATCH] chore: update readme

---
 README.md | 22 ++++++++++++++++++----
 1 file changed, 18 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 7a2c69a..f735cdf 100644
--- a/README.md
+++ b/README.md
@@ -58,16 +58,26 @@ A basic starter for a web app with parceljs, node, express and mongoose -->
 
 ---
 
-## Pre-start
+## Pre-requisites
 
     - yarn
     - docker
 
 ## Features
 
-    - Babel 7
-    - Express
-    - Bunyan
+    - Mongo support
+    - Docker support
+    - Rate limited APIs
+    - RBAC middleware using Auth0
+    - Sharding mongoDB collection support
+    - Paginated APIs
+    - Autogenerated APIs from mongoose models
+    - Built in slack alerting mecchanism
+    - Suport for redis cache
+    - Support for aggregate caching
+    - Support for batch jobs in multi-container environment
+    - Support for circuit breakers
+    - Autogenerated swagger documentation
 
 ## Build and run docker container locally
 
@@ -103,6 +113,10 @@ Run the following command to begin seeding
     - yarn start
     - open browser to `localhost:9000` (port default to 9000)
 
+## API Documentation
+
+Once you've to the server started check out the api documentation at [/api-docs](http://localhost:9000/api-docs)
+
 ## Philosophy
 
 When using NoSQLs you are optimising for read performance. We're doing this by denormalising data. There are multiple copies of the same data. For example