jerpint commited on
Commit
243f480
·
1 Parent(s): 782e950

update readme

Browse files
Files changed (1) hide show
  1. README.md +3 -3
README.md CHANGED
@@ -16,7 +16,7 @@ license: mit
16
 
17
  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!
18
 
19
- ## Usage
20
 
21
  1) Go to the [example space](https://huggingface.co/spaces/jerpint/RAGTheDocs)
22
  2) Duplicate the space:
@@ -26,7 +26,7 @@ RAGTheDocs is an open-source library that allows you to deploy retrieval augment
26
  3) Set your environment variables:
27
  * `OPENAI_API_KEY`: Needed for the app to work, e.g. `sk-...`
28
  * `READTHEDOCS_URL`: The url of the website you are interested in scraping
29
- * `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.
30
 
31
  **WARNING** This library is experimental and automatically calls OpenAI APIs for you. Use at your own risk! ⚠️
32
 
@@ -37,4 +37,4 @@ RAGTheDocs is an open-source library that allows you to deploy retrieval augment
37
 
38
  - **RAG Interface:** It comes built-in with a gradio UI for users to interact with [Buster 🤖](https://github.com/jerpint/buste) our RAG agent.
39
 
40
- - **Customization Options:** Tailor RAGtheDocs to your needs with customizable settings and options.
 
16
 
17
  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!
18
 
19
+ ## Usage 👉
20
 
21
  1) Go to the [example space](https://huggingface.co/spaces/jerpint/RAGTheDocs)
22
  2) Duplicate the space:
 
26
  3) Set your environment variables:
27
  * `OPENAI_API_KEY`: Needed for the app to work, e.g. `sk-...`
28
  * `READTHEDOCS_URL`: The url of the website you are interested in scraping
29
+ * `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!).
30
 
31
  **WARNING** This library is experimental and automatically calls OpenAI APIs for you. Use at your own risk! ⚠️
32
 
 
37
 
38
  - **RAG Interface:** It comes built-in with a gradio UI for users to interact with [Buster 🤖](https://github.com/jerpint/buste) our RAG agent.
39
 
40
+ - **Customization Options:** Tailor RAGtheDocs prompts and settings with customizable settings and options.