From 712a7633d4b61e3c0415a25a7f2fb53fe8b1600d Mon Sep 17 00:00:00 2001 From: Mert Cobanov Date: Thu, 21 Mar 2024 13:48:23 +0300 Subject: [PATCH] Update README.md --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dbc1fda..e5846b2 100644 --- a/README.md +++ b/README.md @@ -1 +1,24 @@ -# easy_docs_summarizer \ No newline at end of file +# Easy Docs Summarizer + +A Python script designed to summarize documents from specified URLs using the LangChain framework and the ChatOllama model. It leverages advanced language models to generate detailed summaries, making it an invaluable tool for quickly understanding the content of web-based documents. + +## Features + +- Summarization of documents directly from URLs. +- Integration with LangChain and ChatOllama for state-of-the-art summarization. +- Command-line interface for easy use and integration into workflows. + +## Usage + +To use the document summarizer, run the script from the command line, providing the URL of the document you wish to summarize: + +```bash +python doc_summarizer.py -u "http://example.com/document" +``` +Replace `http://example.com/document` with the actual URL of the document you want to summarize. + +## Development +To contribute to the development of this script, clone the repository, make your changes, and submit a pull request. We welcome contributions that improve the script's functionality or extend its capabilities. + +## License +This script is released under the MIT License. See the LICENSE file in the repository for full details.