From 79bb79debc0ba843751dacf7bdeade6f8fbe2371 Mon Sep 17 00:00:00 2001
From: DHRUVKADAM22 <147514863+DHRUVKADAM22@users.noreply.github.com>
Date: Tue, 10 Oct 2023 23:29:46 +0530
Subject: [PATCH] Update README.md

I have added quick start guide for windows more specifically
makes more user friendly by adding basic info and description
(which make user or newbies to get understand properly.)
---
 README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)

diff --git a/README.md b/README.md
index db561862..f8d977ce 100644
--- a/README.md
+++ b/README.md
@@ -105,6 +105,47 @@ Otherwise, refer to this Guide:
 
 To stop, just run `Ctrl + C`.
 
+
+For WINDOWS:
+
+To run the given setup on Windows, you can use the Windows Subsystem for Linux (WSL) or a Git Bash terminal to execute similar commands. Here are the steps adapted for Windows:
+
+Option 1: Using Windows Subsystem for Linux (WSL):
+
+1. Install WSL if you haven't already. You can follow the official Microsoft documentation for installation: (https://learn.microsoft.com/en-us/windows/wsl/install).
+2. After setting up WSL, open the WSL terminal.
+3. Clone the repository and create the `.env` file:
+   ```
+   git clone https://github.com/arc53/DocsGPT.git
+   cd DocsGPT
+   echo "API_KEY=Yourkey" > .env
+   echo "VITE_API_STREAMING=true" >> .env
+   ```
+4. Run the following command to start the setup with Docker Compose:
+    `./run-with-docker-compose.sh`
+5. Open your web browser and navigate to (http://localhost:5173/).
+6. To stop the setup, just press `Ctrl + C` in the WSL terminal
+
+Option 2: Using Git Bash or Command Prompt (CMD):
+
+1. Install Git for Windows if you haven't already. You can download it from the official website: (https://gitforwindows.org/).
+2. Open Git Bash or Command Prompt.
+3. Clone the repository and create the `.env` file:
+   ```
+   git clone https://github.com/arc53/DocsGPT.git
+   cd DocsGPT
+   echo "API_KEY=Yourkey" > .env
+   echo "VITE_API_STREAMING=true" >> .env
+
+   ```
+4.Run the following command to start the setup with Docker Compose:
+  `./run-with-docker-compose.sh`
+5.Open your web browser and navigate to (http://localhost:5173/).
+6.To stop the setup, just press Ctrl + C in the Git Bash or Command Prompt terminal.
+
+These steps should help you set up and run the project on Windows using either WSL or Git Bash/Command Prompt. Make sure you have Docker installed and properly configured on your Windows system for this to work.
+
+
 ## Development environments
 
 ### Spin up mongo and redis