Update README.md

README.md

@@ -14,10 +14,30 @@ license: "gpl-3.0"
 sdk_version: "1.52.1"
 ---
 
+# Welcome to Our Hugging Face Deployment
 
-# Welcome to Streamlit!
+This Space hosts the **BPL RAG System** demo for DS 549. To see the full codebase, documentation, and development workflow, visit the GitHub repository:
 
-Edit `/src/streamlit_app.py` to customize this app to your heart's desire. :heart:
+👉 **https://github.com/BU-Spark/ml-bpl-rag**
+
+---
+
+## Known Issues & Notes
+
+### 1. Streamlit SDK Deprecation on Hugging Face
+Hugging Face has deprecated the native **Streamlit SDK**, and Spaces now deploy using **Docker** under the hood. Even if the Space is configured as "Streamlit," it still builds and runs inside a Docker container.
+
+### 2. Docker Deployment Stuck on "Restarting"
+Switching the Space to the explicit **Docker** SDK causes the container to get stuck in a perpetual "Restarting" state. This appears to be a Spaces-level issue rather than something wrong with the app.
+
+### 3. Docker Blocks Outgoing Calls to OpenAI
+Spaces running via Docker **cannot make outbound API calls to OpenAI**. This breaks any RAG workflow that relies on `openai` as the LLM provider.
+
+#### ✔ Workaround
+To bypass this limitation, we switched the LLM provider to **OpenRouter.ai**, which *does* allow outbound API calls from Docker-based Spaces.
+
+
+---
+
+Feel free to explore the app and report any issues through GitHub!
 
-If you have any questions, checkout our [documentation](https://docs.streamlit.io) and [community
-forums](https://discuss.streamlit.io).