README

Author: StiftungAusNachlass

README.md

@@ -5,7 +5,7 @@ developers.
 
 # fylr-plugin-default-values-from-pool
 
-This is a plugin for [fylr](https://documentation.fylr.cloud/docs). Configure standard fields in the baseconfig, which can be defined per pool and then integrated into masks. These can then be used in the data model to assign default values to fields.
+This is a plugin for [fylr](https://documentation.fylr.cloud/docs). Configure standard fields in the baseconfig, which can be defined per pool and then integrated into masks. This plugin is meant to configure for example default values for "licence", "rightsholder", "institution" etc. for each pool. Records in this pool can show these values in the matching fields. This plugin does not manipulate or set any data in editor. 
 
 ## installation
 
@@ -15,6 +15,18 @@ The ZIP can be downloaded and installed using the plugin manager, or used direct
 
 Github has an overview page to get a list of [all release](https://github.com/programmfabrik/fylr-plugin-default-values-from-pool/releases/).
 
+## setup
+
+1. First create your objecttype in the datamodel.
+2. Switch to your-fylr.com/configmanager and choose the options for "default-values-from-pool"
+3. Enter your configuration for the needed default values, according to your datamodel. It is important to choose the correct path for the fieldname. If you are not sure, activate the "debug"-Checkbox - after that all fieldpaths are logged when you click on a pool in the poolmanager.
+![configuration_example](https://github.com/programmfabrik/fylr-plugin-default-values-from-pool/blob/master/img/config_example.png?raw=true)
+4. Go to your-fylr.com/poolmanager and enter the default values in the tab "default values"
+![pool_example](https://github.com/programmfabrik/fylr-plugin-default-values-from-pool/blob/master/img/pool_example.png?raw=true)
+5. Finalize by adding the "default-values"-splitter to your mask in datamodel
+![pool_example](https://github.com/programmfabrik/fylr-plugin-default-values-from-pool/blob/master/img/mask_example.png?raw=true)
+6. Activate new datamodel and test in editor
+
 ## sources
 
 The source code of this plugin is managed in a git repository at <https://github.com/programmfabrik/fylr-plugin-default-values-from-pool>.