summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md32
1 files changed, 31 insertions, 1 deletions
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: