Merge pull request #28 from vselvarajijay/main

Updating onboarding docs

README.md

@@ -10,21 +10,13 @@ Akello is a developer platform that enables flexible and rapid development of po
 - **Akello SDK** - Client libraries that simplify the process of interacting with the **Akello API**.
 - **Akello App** - Web application where you can view your data and perform basic editing tasks. You can also use the Akello App to manage basic workflows.
 
-## Setup and run local
+## Quick start guide
 
-Run the API Server, defaults to http://localhost:8000
-```console
-foo@bar:~$ cd packages/server
-foo@bar:~$ pip install -r requirements.text
-foo@bar:~$ uvicorn main:app --reload
-```
+The best way to start working with akello and seeing how it works is by trying out one of our examples under /examples
+
+Example Docs
+ * [Run your own custom API with akello](https://github.com/akello-io/akello/blob/main/examples/foo-api/README.md)
 
-Run the API Server, defaults to http://localhost:5432
-```console
-foo@bar:~$ cd packages/apps/cocm-registry
-foo@bar:~$ npm install
-foo@bar:~$ npm run start
-```
 
 ## CoCM Registry App
 

examples/foo-api/README.md

@@ -3,6 +3,18 @@
 
 This is an example app of how to run your own API using akello.
 
+## Quick Start
+
+If you already have **DynamoDB** running locally, an AWS account and the **environment variables** set (see below) then you just need to run the following commands.
+
+```commandline
+pip install -r requirements.text
+uvicorn main:app --reload
+```
+
+The server will be running on http://localhost:8000
+
+
 ## Install akello and integrate into your Fast API server
 
 ```commandline