diff --git a/README.md b/README.md index e6d5a52c..dd0ac905 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,27 @@ -# DocsGPT 🦖 +
+ Open-Source Documentation Assistant +
-Screenshot
++ DocsGPT is a cutting-edge open-source solution that streamlines the process of finding information in project documentation. With its integration of the powerful GPT models, developers can easily ask questions about a project and receive accurate answers. + +Say goodbye to time-consuming manual searches, and let DocsGPT help you quickly find the information you need. Try it out and see how it revolutionizes your project documentation experience. Contribute to its development and be a part of the future of AI-powered assistance. +
+ +
## [Live preview](https://docsgpt.arc53.com/)
@@ -40,16 +58,11 @@ Built with [🦜️🔗 LangChain](https://github.com/hwchase17/langchain)
## Roadmap
-Good vectorDB scraping/parsing
+- Good vectorDB scraping/parsing
+- Load vectors in UI from arc53
+- Better UI
+- More prompts for other languages
+- Better parsing
+- Extensions for firefox
+- Extensions for Vscode
-Load vectors in UI from arc53
-
-better UI
-
-More prompts for other languages
-
-Better parsing
-
-Extensions for firefox
-
-Extensions for Vscode
diff --git a/Readme Logo.png b/Readme Logo.png
new file mode 100644
index 00000000..aad92a75
Binary files /dev/null and b/Readme Logo.png differ