diff --git a/README.md b/README.md
index 58b01c2..dad8de6 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,55 @@
[![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)
+
# Fastify Rest API with MySQL Starter
Boilerplate project for bootstrapping development of a Rest API application with NodeJS, Fastify, and MySQL
-# LICENSE
+## Getting Started
+
+### Clone the repository
+
+```console
+git clone https://github.com/spinsage/fastify-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
+
**Fastify Rest API with MySQL Starter** is Apache 2-licensed.
-
-# 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.
\ No newline at end of file
diff --git a/package-lock.json b/package-lock.json
index e8a870f..55520b9 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -14,7 +14,7 @@
"fastify-sequelize": "^1.0.4",
"mysql2": "^2.3.3",
"pino-pretty": "^7.3.0",
- "sequelize": "^6.12.0-alpha.1",
+ "sequelize": "^6.12.4",
"uuid": "^8.3.2"
},
"devDependencies": {
@@ -2632,9 +2632,9 @@
"integrity": "sha1-1WgS4cAXpuTnw+Ojeh2m143TyT4="
},
"node_modules/sequelize": {
- "version": "6.12.2",
- "resolved": "https://registry.npmjs.org/sequelize/-/sequelize-6.12.2.tgz",
- "integrity": "sha512-MjrvyROlvCs44u0XXBsjAKTKSOCI6djFyimlak4Urr6XGSpka5+PD40PlDgJSuCRwIdvyDUdAQl0cw7E68YqqQ==",
+ "version": "6.12.4",
+ "resolved": "https://registry.npmjs.org/sequelize/-/sequelize-6.12.4.tgz",
+ "integrity": "sha512-P2E8TzlV3VwdvPqTS58ctIpcAOytXdaylUUfxxnALjtMmF6I+kfNtrqTP7WQFaenOboAtXPCJReZ9MPy+Zy/Ig==",
"funding": [
{
"type": "opencollective",
@@ -5274,9 +5274,9 @@
"integrity": "sha1-1WgS4cAXpuTnw+Ojeh2m143TyT4="
},
"sequelize": {
- "version": "6.12.2",
- "resolved": "https://registry.npmjs.org/sequelize/-/sequelize-6.12.2.tgz",
- "integrity": "sha512-MjrvyROlvCs44u0XXBsjAKTKSOCI6djFyimlak4Urr6XGSpka5+PD40PlDgJSuCRwIdvyDUdAQl0cw7E68YqqQ==",
+ "version": "6.12.4",
+ "resolved": "https://registry.npmjs.org/sequelize/-/sequelize-6.12.4.tgz",
+ "integrity": "sha512-P2E8TzlV3VwdvPqTS58ctIpcAOytXdaylUUfxxnALjtMmF6I+kfNtrqTP7WQFaenOboAtXPCJReZ9MPy+Zy/Ig==",
"requires": {
"@types/debug": "^4.1.7",
"debug": "^4.3.3",
diff --git a/package.json b/package.json
index 352ad3e..f55d924 100644
--- a/package.json
+++ b/package.json
@@ -28,7 +28,7 @@
"fastify-sequelize": "^1.0.4",
"mysql2": "^2.3.3",
"pino-pretty": "^7.3.0",
- "sequelize": "^6.12.0-alpha.1",
+ "sequelize": "^6.12.4",
"uuid": "^8.3.2"
},
"devDependencies": {