From fc61b27f1cebcb7fb1d319afbb43e1fcc787cc62 Mon Sep 17 00:00:00 2001
From: Ibrahim Raimi <raimiibrahim44@gmail.com>
Date: Wed, 10 Apr 2024 19:58:18 +0100
Subject: [PATCH] update readme

---
 README.md | 34 +++++++++++++++++++++++-----------
 1 file changed, 23 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index d599bee..7c9d90c 100644
--- a/README.md
+++ b/README.md
@@ -2,37 +2,49 @@
 
 The QuickSail Stack is a versatile and efficient boilerplate for web application development, designed to help developers set sail quickly on their SAAS project.
 
-<!-- ### Introduction
+### Local Setup
 
-Welcome to the QuickSail Stack documentation! This guide is crafted specifically for solo-entrepreneurs seeking to expedite the development and deployment of their SaaS products. With QuickSail Stack, you can focus on building your business logic while leveraging a powerful tech stack to handle the rest. -->
+Clone the QuickSail repository from GitHub.
 
-### Installation
+```sh
+git clone https://github.com/ibrahimraimi/quicksail
+```
+#### Install dependencies
 
-- Clone the QuickSail repository from GitHub.
-- Install dependencies using npm, pnpm or yarn.
+> Make sure to give execute permissions to the script
 
 ```sh
-git clone https://github.com/ibrahimraimi/quicksail
+chmod +x ./scripts/install_dependencies.sh
+```
+
+> Then you can run the script:
 
-cd quicksail-stack
-pnpm install
+```sh
+./scripts/install_dependencies.sh
 ```
 
 ### Development
 
 Run the development server to start building your application.
 
+> Make sure to give execute permissions to the script
+```sh
+chmod +x ./scripts/start_servers.sh
+```
+
+> Start development server
+
 ```sh
-pnpm dev
+./scripts/start_servers.sh
 ```
 
-### Deployment
+<!-- ### Deployment
 
 Dockerize your application for deployment to production environments.
 
 ```sh
 docker-compose up --build
-```
+``` -->
 
 ### License