From 19bcc07814e7f20d7392e3e081a0de784578d657 Mon Sep 17 00:00:00 2001 From: yichuan520030910320 Date: Mon, 28 Jul 2025 20:52:45 -0700 Subject: [PATCH] change readme discription --- README.md | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 91b55c6..a5b7280 100755 --- a/README.md +++ b/README.md @@ -174,15 +174,28 @@ Ask questions directly about your personal PDFs, documents, and any directory co LEANN Document Search Demo

-The example below asks a question about summarizing two papers (uses default data in `examples/data`): +The example below asks a question about summarizing two papers (uses default data in `examples/data`) and this is the easiest example to run here: -``` -# Or use python directly +```bash source .venv/bin/activate python ./examples/main_cli_example.py ``` +
+📋 Click to expand: User Configurable Arguments +```bash +# Use custom index directory +python examples/main_cli_example.py --index-dir "./my_custom_index" + +# Use custom data directory +python examples/main_cli_example.py --data-dir "./my_documents" + +# Ask a specific question +python examples/main_cli_example.py --query "What are the main findings in these papers?" +``` + +
### 📧 Your Personal Email Secretary: RAG on Apple Mail! @@ -195,12 +208,12 @@ python ./examples/main_cli_example.py **Note:** You need to grant full disk access to your terminal/VS Code in System Preferences → Privacy & Security → Full Disk Access. ```bash -python examples/mail_reader_leann.py --query "What's the food I ordered by doordash or Uber eat mostly?" +python examples/mail_reader_leann.py --query "What's the food I ordered by DoorDash or Uber Eats mostly?" ``` -**780K email chunks → 78MB storage** Finally, search your email like you search Google. +**780K email chunks → 78MB storage.** Finally, search your email like you search Google.
-📋 Click to expand: Command Examples +📋 Click to expand: User Configurable Arguments ```bash # Use default mail path (works for most macOS setups) @@ -242,7 +255,7 @@ python examples/google_history_reader_leann.py --query "Tell me my browser histo **38K browser entries → 6MB storage.** Your browser history becomes your personal search engine.
-📋 Click to expand: Command Examples +📋 Click to expand: User Configurable Arguments ```bash # Use default Chrome profile (auto-finds all profiles) @@ -319,7 +332,7 @@ Failed to find or export WeChat data. Exiting.
-📋 Click to expand: Command Examples +📋 Click to expand: User Configurable Arguments ```bash # Use default settings (recommended for first run)