Merge pull request #9 from opengisch/littledescription

Little description
opengisch · Dec 1, 2022 · 3a1cc45 · 3a1cc45
2 parents c795606 + ef28f3b
commit 3a1cc45
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,16 @@
-## Ordered Relation Editor plugin for QGIS
+# Ordered Relation Editor plugin for QGIS
+
+A plugin providing a relation editor widget with capability to reorder linked children based on an ordering field.
+
+![Overview](docs/images/Overview.gif)
+
+
+## Configuration
+
+In the attribute form configuration select `Ordered relation editor` and configure the widget under Widget Configuration:
+
+- **Ordering Field** Which field of the linked table is used for ordering.
+- **Description** This expression provides the text displayed in the children list.
+- **Image path** Optionally a path to an image or icon to display near the Description text.
+
+![Overview](docs/images/Configuration.png)
diff --git a/docs/images/Configuration.png b/docs/images/Configuration.png
diff --git a/docs/images/Overview.gif b/docs/images/Overview.gif