Skip to content

Commit 3909659

Browse files
authored
add screenshots to README
to give a better visual indication of what this library provides
1 parent df11a94 commit 3909659

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
A reusable Wagtail block that displays thumbnail images for choice fields, making it easier for content editors to visually select options.
44

5+
## Examples
6+
7+
A theme field may want to display a thumbnail of each available theme:
8+
<img width="1001" height="335" alt="example-theme" src="https://github.com/user-attachments/assets/6ebbbce4-df4f-4c02-a7ad-baaecd2fae53" />
9+
10+
An icon field may want to display a thumbnail of each available icon:
11+
<img width="1013" height="390" alt="example-icon" src="https://github.com/user-attachments/assets/1bcdfa54-bede-4db6-a402-2a3762c59567" />
12+
13+
514
## Features
615

716
- **Visual Selection**: Display thumbnail images (recommended 80x80px) for each choice option
@@ -292,4 +301,4 @@ Contributions are welcome! Please feel free to submit a Pull Request.
292301

293302
Releases are done with GitHub Actions whenever a new tag is created. For more information,
294303
see [build.yml](.github/workflows/build.yml). If adding a new tag, make sure to first update the
295-
version in pyproject.toml.
304+
version in pyproject.toml.

0 commit comments

Comments
 (0)