From c1a5d0c6244c70f8c3e068edacd5d763523669fc Mon Sep 17 00:00:00 2001 From: yichuan520030910320 Date: Sun, 27 Jul 2025 02:24:28 -0700 Subject: [PATCH] fix readme --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7e930de..dfd6b4d 100755 --- a/README.md +++ b/README.md @@ -147,6 +147,15 @@ response = chat.ask( LEANN supports RAG on various data sources including documents (.pdf, .txt, .md), Apple Mail, Google Search History, WeChat, and more. +Our project provides many **ready-to-use examples**. If you installed LEANN via pip, you can clone our examples and run them immediately: + +```bash +git clone git@github.com:yichuan-w/LEANN.git leann +cd leann +``` + +> **Note:** If you built from source, you already have the examples and can skip cloning. + ### 📄 Personal Data Manager: Process Any Documents (.pdf, .txt, .md)! Ask questions directly about your personal PDFs, documents, and any directory containing your files! @@ -172,14 +181,7 @@ python ./examples/main_cli_example.py ### 📧 Your Personal Email Secretary: RAG on Apple Mail! -Our project provides many **ready-to-use examples**. If you installed LEANN via pip, you can clone our examples and run them immediately: -```bash -git clone git@github.com:yichuan-w/LEANN.git leann -cd leann -``` - -> **Note:** If you built from source, you already have the examples and can skip cloning.

LEANN Email Search Demo