Merge pull request #7 from JoshuaC215/JoshuaC215-patch-1

Add quickstart to readme
JoshuaC215 · Aug 23, 2024 · 142989e · 142989e
2 parents 7d8d595 + b8776f4
commit 142989e
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -15,7 +15,25 @@ This project offers a template for you to easily build and run your own agents u
 
 <a href="https://agent-service-toolkit.streamlit.app/"><img src="media/app_screenshot.png" width="600"></a>
 
+### Quickstart
 
+Run directly in python
+
+```sh
+echo 'OPENAI_API_KEY=your_openai_api_key' >> .env
+pip install -r requirements.txt
+python run_service.py
+
+# In another shell
+streamlit run streamlit_app.py
+```
+
+Run with docker
+
+```sh
+echo 'OPENAI_API_KEY=your_openai_api_key' >> .env
+docker compose watch
+```
 
 ### Architecture Diagram