update readme

README.md

@@ -14,7 +14,7 @@ license: mit
 
 ## Introduction 📚
 
-RAGTheDocs is an open-source library that allows you to deploy retrieval augmented generation (RAG) on any readthedocs documentation with a one-click deploy on huggingface spaces!
+RAGTheDocs is an open-source library that allows you to **one-click deploy** retrieval augmented generation (RAG) on any readthedocs documentation on [huggingface 🤗 spaces](https://huggingface.co/spaces/jerpint/RAGTheDocs)!
 
 ## Usage 👉
 
@@ -24,12 +24,9 @@ RAGTheDocs is an open-source library that allows you to deploy retrieval augment
 ![image](https://github.com/jerpint/buster/assets/18450628/0c89038c-c3af-4c1f-9d3b-9b4d83db4910)
 
 3) Set your environment variables:
-* `OPENAI_API_KEY`: Needed for the app to work, e.g. `sk-...`
-* `READTHEDOCS_URL`: The url of the website you are interested in scraping
-* `READTHEDOCS_VERSION`: This is important **only** if there exist multiple versions of the docs (e.g. "en/v0.2.7" or "en/latest"). If left empty, it will scrape all available versions (there can be many for open-source projects!).
-
-**WARNING** This library is experimental and automatically calls OpenAI APIs for you. Use at your own risk! ⚠️
-
+* `OPENAI_API_KEY` (required): Needed for the app to work, e.g. `sk-...`
+* `READTHEDOCS_URL` (required): The url of the website you are interested in scraping
+* `READTHEDOCS_VERSION` (optional): This is important **only** if there exist multiple versions of the docs (e.g. "en/v0.2.7" or "en/latest"). If left empty, it will scrape all available versions (there can be many for open-source projects!).
 
 ## Features 🚀
 
@@ -38,3 +35,12 @@ RAGTheDocs is an open-source library that allows you to deploy retrieval augment
 - **RAG Interface:** It comes built-in with a gradio UI for users to interact with [Buster 🤖](https://github.com/jerpint/buste) our RAG agent.
 
 - **Customization Options:** Tailor RAGtheDocs prompts and settings with customizable settings and options.
+
+## Disclaimers ❗
+
+* This is a quickly hacked together side-project. This code should be considered experimental at best.
+
+* This library will automatically call OpenAI APIs for you (for embeddings and chatGPT).
+
+* Use at your own risk! ⚠️
+

app.py

@@ -129,9 +129,14 @@ with demo:
         """
         ## About
         [RAGTheDocs](https://github.com/jerpint/RAGTheDocs) allows you to ask questions about any documentation hosted on readthedocs.
-        Simply clone this space and point it to the right URL!
+        Simply clone this space and set the environment variables:
 
-        Try it out by asking a question below about [orion](https://orion.readthedocs.io/), an open-source hyperparameter optimization library.
+        * `OPENAI_API_KEY` (required): Needed for the app to work, e.g. `sk-...`
+        * `READTHEDOCS_URL` (required): The url of the website you are interested in scraping (must be built with
+        sphinx/readthedocs)
+        * `READTHEDOCS_VERSION` (optional): This is important **only** if there exist multiple versions of the docs (e.g. "en/v0.2.7" or "en/latest"). If left empty, it will scrape all available versions (there can be many for open-source projects!).
+
+        Try it out by asking a question below 👇 about [orion](https://orion.readthedocs.io/), an open-source hyperparameter optimization library.
 
         ## How it works
         This app uses [Buster 🤖](https://github.com/jerpint/buster) and ChatGPT to search the docs for relevant info and