Skip to content

Commit 0ce38f1

Browse files
authored
README has an earlier example
Refs #1
1 parent 81946ab commit 0ce38f1

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,12 @@ The `llm-pdf-to-images` plugin provides a [fragment loader](https://llm.datasett
1717

1818
You can use the `pdf-to-images:` fragment prefix to convert a PDF file into a series of image attachments which can be sent to a model.
1919

20+
Example usage:
21+
22+
```bash
23+
llm -f pdf-to-images:path/to/document.pdf 'Summarize this document'
24+
```
25+
2026
### Fragment syntax
2127

2228
```
@@ -28,7 +34,7 @@ pdf-to-images:<path>?dpi=N&format=jpg|png&quality=Q
2834
- `format=jpg|png`: (optional) Image format to use for the output. Can be either `jpg` (default) or `png`.
2935
- `quality=Q`: (optional) JPEG quality factor between 1 and 100. Only applies when using JPG format. Defaults to `30` if omitted. Higher values produce better quality but larger file sizes.
3036

31-
### Examples
37+
### More examples
3238

3339
Convert a PDF file to images with default settings (300 DPI, JPG format, quality 30):
3440

0 commit comments

Comments
 (0)