Update README

README.md

@@ -14,25 +14,27 @@ license: mit
 
 ## Introduction 📚
 
-RAGTheDocs is an open-source library that allows you to do RAG on any readthedocs documentation using a one-click deploy.
+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!
 
-## Features 🚀
-
-- **Web Scraping and Analysis:** RAGtheDocs automatically scrapes and embeds documentation from any website generated by ReadTheDocs/Sphinx
+## Usage
 
-- **RAG Interface:** It comes built-in with a gradio UI for users to interact with the RAG agent
+1) Go to the [example space](https://huggingface.co/spaces/jerpint/RAGTheDocs)
+2) Duplicate the space:
 
-- **Customization Options:** Tailor RAGtheDocs to your needs with customizable settings and options.
+![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.
 
-## Installation
+**WARNING** This library is experimental and automatically calls OpenAI APIs for you. Use at your own risk! ⚠️
 
-TODO
 
-## Usage
+## Features 🚀
 
-TODO
+- **Web Scraping and embeddings:** RAGtheDocs automatically scrapes and embeds documentation from any website generated by ReadTheDocs/Sphinx using OpenAI embeddings
 
-## Configuration
+- **RAG Interface:** It comes built-in with a gradio UI for users to interact with [Buster 🤖](github.com/jerpint/buster) our RAG agent.
 
-TODO
+- **Customization Options:** Tailor RAGtheDocs to your needs with customizable settings and options.