document example schema

ckan · Jun 27, 2024 · 1c29c01 · 1c29c01
1 parent 26181fd
commit 1c29c01
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -30,6 +30,16 @@ scheming.presets = ckanext.scheming:presets.json
                    ckanext.fluent:presets.json
 ```
 
+An [example schema](https://github.com/ckan/ckanext-fluent/blob/master/ckanext/fluent/fluent_scheming.yaml)
+is may be used with the `scheming_datasets` plugin and this schema setting:
+
+```ini
+scheming.dataset_schemas=ckanext.fluent:fluent_scheming.yaml
+```
+
+This example schema registers a new `fluent-test` dataset type. Visit
+`/fluent-test/new` on your ckan site to create a new dataset with this schema.
+
 ## `fluent_text` fields
 
 A fluent multilingual text field in a scheming schema: