From 5687748f7645f925d0052626641c6eaf08f01222 Mon Sep 17 00:00:00 2001
From: spinsager <63341255+spinsager@users.noreply.github.com>
Date: Mon, 3 Jan 2022 09:47:25 +0530
Subject: [PATCH] Update README.md

---
 README.md | 48 +++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 45 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 8fd0d16..d9f2e8b 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,56 @@
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/spinsage/community)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
 
 # Express Rest API with MySQL Starter
+
 Boilerplate project for bootstrapping the development of a Rest API application with NodeJS, Express, and MySQL
 
-# LICENSE
+## Getting Started
+
+### Clone the repository
+
+```console
+git clone https://github.com/spinsage/express-js-rdbms-starter-rest.git
+```
+
+### Install dependencies
+
+```console
+npm install
+```
+
+### Configure environment variables
+
+- Create a .env file by copying .env.sample.
+- Update environment variable values in the .env file as needed.
+
+### Run the application
+
+#### For development
+
+```console
+npm run start-dev
+```
+
+#### For deployment
+
+```console
+npm run start
+```
+
+#### Within a Docker container
+
+```console
+docker-compose up
+```  
+
+## LICENSE
+
 **Express Rest API with MySQL Starter** is Apache 2-licensed.
-<br><br>
 
-# Let us know!
+## Let us know!
+
 We at [**Spinsage**](https://www.spinsage.com/) would be happy if you send us links to your projects where you are using our code. Just send us an email at opensource@spinsage.com.
 
 And do let us know if you have any queries or suggestions regarding our work.