From f3c1b568ac28e211d218f0b33ccb85cf782ce248 Mon Sep 17 00:00:00 2001
From: Paul Buetow <paul@buetow.org>
Date: Fri, 18 Jul 2025 20:18:48 +0300
Subject: docs: update README with batch file translation format
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

- Added documentation for 'bulgarian = english' batch file format
- Included examples of all three supported formats
- Added note about API quota savings when providing translations
- Updated Quick Start section with example batch file

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
---
 README.md | 32 +++++++++++++++++++++++++++++++-
 1 file changed, 31 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 583de85..beb8a75 100644
--- a/README.md
+++ b/README.md
@@ -70,6 +70,14 @@ export OPENAI_API_KEY="sk-..."
    ```bash
    totalrecall --batch words.txt
    ```
+   
+   Example `words.txt` with translations:
+   ```
+   книга = book
+   стол = table
+   компютър
+   молив = pencil
+   ```
 
 4. Generate with Anki package:
    ```bash
@@ -137,7 +145,9 @@ totalrecall --gui
 
 ### Batch file format
 
-Create a text file with one Bulgarian word per line:
+Create a text file with Bulgarian words, optionally with English translations:
+
+**Format 1: Bulgarian words only**
 ```
 ябълка
 котка
@@ -146,6 +156,26 @@ Create a text file with one Bulgarian word per line:
 вода
 ```
 
+**Format 2: Bulgarian words with translations**
+```
+книга = book
+стол = table
+прозорец = window
+компютър = computer
+молив = pencil
+```
+
+**Format 3: Mixed format**
+```
+книга = book
+котка
+стол = table
+куче
+молив = pencil
+```
+
+When translations are provided, they are used directly without calling the translation API, saving time and API quota. Spaces around the words and translations are automatically trimmed.
+
 ### Output Files
 
 For each word, the tool generates:
-- 
cgit v1.2.3