From 8349676276b0f96423e96a6caed93b0c71a1d3ff Mon Sep 17 00:00:00 2001
From: Miles Lincoln <milesl@berkeley.edu>
Date: Fri, 13 Dec 2024 13:52:00 -0800
Subject: [PATCH] NOJIRA Update Readme

---
 README.md | 40 +++++++++++++++++++++++++---------------
 1 file changed, 25 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index 74d99d7..905e67d 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
 # bCourses Support ChatBot
-Gen AI based bcourses support chatbot POC
+Gen AI based bCourses support chatbot POC
 This repository contains the code for a Streamlit-based chatbot application using LangChain and AWS Bedrock.
 
 ## Features
@@ -11,17 +11,27 @@ This repository contains the code for a Streamlit-based chatbot application usin
 
 ## Setup Instructions
 
-1. Clone the repository:
-   git clone https://github.com/ets-berkeley-edu/bcourses-chatbot-poc.git
-   cd bcourses-chatbot-poc
-
-2. Install dependencies
-   pip install -r requirements.txt
-
-3. Configure environments
-   config/development.py for development
-   config/development-local.py for local settings
-
-4. Run streamlit application
-   streamlit run app/main.py
-
+### Clone the Repository:
+```
+git clone https://github.com/ets-berkeley-edu/bcourses-chatbot-poc.git
+cd bcourses-chatbot-poc
+```
+
+* Install Python 3
+* Create your virtual environment (venv)
+* Install dependencies
+
+```
+pip3 install -r requirements.txt [--upgrade]
+```
+
+### Configure Environments
+```
+export APP_ENV=development
+export APP_LOCAL_CONFIGS=~/Volumes/XYZ/bcourses_chatbot_poc_config
+```
+
+### Run Streamlit Application
+```
+streamlit run app/main.py
+```