From 137912aa1179ed2394afc4b56dc933187a194c34 Mon Sep 17 00:00:00 2001
From: Swapnil Bendal <84583651+Swapnil155@users.noreply.github.com>
Date: Fri, 20 Dec 2024 20:08:44 +0530
Subject: [PATCH] [update] - readme

---
 README.md | 37 +++++++++++++++++++++++++------------
 1 file changed, 25 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 2d74cf5..af0d7c6 100644
--- a/README.md
+++ b/README.md
@@ -37,11 +37,11 @@ The project is **live and operational**, catering specifically to the investment
 ### **Steps**
 1. Clone the repository:  
 	```bash
-	git clone http://git.wdipl.com/Siddhesh.More/tanami-admin-panel.git
+	git clone http://git.wdipl.com/Siddhesh.More/tanami-admin.git
 	```
 2. Navigate to the project directory:  
 	```bash
-	cd tanami-admin-panel
+	cd tanami-admin
 	```
 3. Install dependencies:  
 	```bash
@@ -67,9 +67,25 @@ The project is **live and operational**, catering specifically to the investment
 	```bash
 	npm install pm2 -g
 	```
-2. Start the production server:  
+
+2. Build the application (if applicable):  
 	```bash
-	npm start
+	npm run build
+	```
+
+3. Serve the application using PM2:
+	```bash
+	pm2 serve ./dist <port_number> --spa --name=<application_name>
+	```
+	Replace:
+	- `./dist` with your build directory.
+	- `<port_number>` with the desired port (e.g., `3000`).
+	- `<application_name>` with the name of your application.
+
+4. Save the PM2 process list and enable startup on system reboot:
+	```bash
+	pm2 save
+	pm2 startup
 	```
 
 ---
@@ -84,17 +100,14 @@ Create a `.env` file in the root directory based on the structure of [`.env.exam
 
 | Script             | Description                                                 |
 |---------------------|-------------------------------------------------------------|
-| `npm start`         | Starts the app in production mode using PM2.                |
-| `npm run dev`       | Starts the app in development mode with `nodemon`.          |
-| `npm run test`      | Starts the app in test mode with `nodemon`.                 |
+| `npm run dev`       | Starts the app in development mode with `Vite` server.      |
+| `npm run build`     | Builds the app for production.                              |
 | `npm run lint`      | Runs ESLint to check for code quality issues.               |
-| `npm run lint:fix`  | Fixes fixable issues detected by ESLint.                    |
-| `npm run prettier`  | Checks code formatting using Prettier.                      |
-| `npm run prettier:fix` | Formats code files according to Prettier rules.          |
-| `npm run prepare`   | Prepares Husky for managing Git hooks.                      |
+| `npm run preview`   | Previews the production build locally.                      |
 
 ---
 
 ## **License**
 
-This project is licensed under the [MIT License](LICENSE).
\ No newline at end of file
+This project is licensed under the [MIT License](LICENSE).
+