From b8f1acfd3cbdb3ec56181d8216b38c5a455f59cf Mon Sep 17 00:00:00 2001 From: Andrew White Date: Thu, 11 Jan 2024 11:33:32 -0800 Subject: [PATCH] Added warning to README --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5740f11f..c5ac1f5e 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,13 @@ -# Paper QA- [Paper QA](#paper-qa) +# PaperQA [![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/whitead/paper-qa) [![tests](https://github.com/whitead/paper-qa/actions/workflows/tests.yml/badge.svg)](https://github.com/whitead/paper-qa) [![PyPI version](https://badge.fury.io/py/paper-qa.svg)](https://badge.fury.io/py/paper-qa) +## YOU ARE LOOKING AT PRE-RELEASE README + +**This is the README for an upcoming v4 release** You can see the current stable version [here](https://github.com/whitead/paper-qa/tree/84f13ea32c22b85924cd681a4b5f4fbd174afd71) + This is a minimal package for doing question and answering from PDFs or text files (which can be raw HTML). It strives to give very good answers, with no hallucinations, by grounding responses with in-text citations.