Document the preview spec

matthiask · Dec 9, 2024 · b4340bc · b4340bc
1 parent 2b60c18
commit b4340bc
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -133,6 +133,17 @@ You should make sure to add the ``form.media`` to your page template's ``<head>`
 Retrieve the image URL in your template like, ``instance.image.thumb``.
 
 
+Forms
+=====
+
+The form widget builds on top of the default Django image field which allows
+resetting the value of the field; it additionally shows a preview image, and if
+there's a linked PPOI field, a PPOI picker.
+
+The default preview is a max. 300x300 thumbnail. You can customize this by
+adding a ``preview`` format spec to the list of formats.
+
+
 Image processors
 ================