Skip to content

Commit 52292f4

Browse files
Added more context and details about WDoc's capabilities and development status to the README.md file.
1 parent 74a24d4 commit 52292f4

1 file changed

Lines changed: 17 additions & 8 deletions

File tree

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,23 @@
55
66
# WDoc
77

8-
* **Goal and project specifications** use [LangChain](https://python.langchain.com/) to summarize, search or query documents. I'm a medical student so I need to be able to query from **tens of thousands** of documents, of different types ([Supported filetypes](#Supported-filetypes)). I also have little free time so I needed a tailor made summary feature to keep up with the news.
9-
* **Current status**: **still under development**.
10-
* I use it almost daily and have been for months now.
11-
* Expect some breakage but they can be fixed usually in a few minutes if you open an issue here.
12-
* The main branch is usually fine but the dev branch has more features.
13-
* I accept feature requests and pull requests.
14-
* Issues are extremely appreciated for any reason including typos etc.
15-
* Prefer asking me before making a PR because I have many improvements in the pipeline but do this on my spare time. Do tell me if you have specific needs!
8+
WDoc is a powerful RAG (Retrieval-Augmented Generation) system designed to summarize, search, and query documents across various file types. It's particularly useful for handling large volumes of diverse document types, making it ideal for researchers, students, and professionals dealing with extensive information sources.
9+
10+
* **Goal and project specifications**: WDoc uses [LangChain](https://python.langchain.com/) to process and analyze documents. It's capable of querying **tens of thousands** of documents across [various file types](#Supported-filetypes). The project also includes a tailored summary feature to help users efficiently keep up with large amounts of information.
11+
12+
* **Current status**: **Under active development**
13+
* Used daily by the developer for several months
14+
* May have some instabilities, but issues can usually be resolved quickly
15+
* The main branch is stable, while the dev branch offers more features
16+
* Open to feature requests and pull requests
17+
* All feedback, including reports of typos, is highly appreciated
18+
* Please consult the developer before making a PR, as there may be ongoing improvements in the pipeline
19+
20+
* **Key Features**:
21+
* Supports multiple file types for comprehensive document analysis
22+
* Utilizes both strong and query evaluation LLMs for accurate results
23+
* Customizable summarization capabilities
24+
* Efficient handling of large document corpora
1625

1726
### Table of contents
1827
- [Features](#features)

0 commit comments

Comments
 (0)