updated README.md

Author: Qsan1

src/hackingBuddyGPT/usecases/rag/README.md

@@ -1,6 +1,14 @@
 # ThesisPrivescPrototype
 This usecase is an extension of `usecase/privesc`.
 
+## Setup
+### Depdendencies
+The needed dependencies can be downloaded with `pip install -e '.[rag-usecase]'`. If you encounter the error `unexpected keyword argument 'proxies'` after trying to start the usecase, try downgrading `httpx` to 0.27.2.
+### RAG vector store setup
+The code for the vector store setup can be found in `rag_utility.py`. Currently the vectore store uses two sources: `GTFObins` and `hacktricks`. To use RAG, download the markdown files and place them in `rag_storage/GTFObinMarkdownfiles` (`rag_storage/hacktricksMarkdownFiles`). You can download the markdown files either from the respective github repository ([GTFObin](https://github.com/GTFOBins/GTFOBins.github.io/tree/master), [hacktricks](https://github.com/HackTricks-wiki/hacktricks/tree/master/src/linux-hardening/privilege-escalation)) or scrap them from their website ([GTFObin](https://gtfobins.github.io/), [hacktricks](https://book.hacktricks.wiki/en/linux-hardening/privilege-escalation/index.html)).
+
+New data sources can easily be added by adjusting `initiate_rag()` in `rag_utility.py`.
+
 ## Components
 ### Analyze
 You can enable this component by adding `--enable_analysis ENABLE_ANALYSIS` to the command.
@@ -22,7 +30,3 @@ If enabled, instead of including all commands and their respective output in the
 You can enable this component by adding `--enable_structure_guidance ENABLE_STRUCTURE_GUIDANCE` to the command.
 
 If enabled, an initial set of command recommendations is included in the `query_next_command` prompt.
-## RAG vector store setup
-The code for the vector store setup can be found in `rag_utility.py`. Currently the vectore store uses two sources: `GTFObins` and `hacktricks`. To use RAG, download the markdown files and place them in `rag_storage/GTFObinMarkdownfiles` (`rag_storage/hacktricksMarkdownFiles`). You can download the markdown files either from the respective github repository ([GTFObin](https://github.com/GTFOBins/GTFOBins.github.io/tree/master), [hacktricks](https://github.com/HackTricks-wiki/hacktricks/tree/master/src/linux-hardening/privilege-escalation)) or scrap them from their website ([GTFObin](https://gtfobins.github.io/), [hacktricks](https://book.hacktricks.wiki/en/linux-hardening/privilege-escalation/index.html)).
-
-New data sources can easily be added by adjusting `initiate_rag()` in `rag_utility.py`.