From 5d3c159059bb470f8b63530d1293c212bad91ef1 Mon Sep 17 00:00:00 2001 From: Kurt Nordstrom Date: Tue, 29 Sep 2026 07:28:15 -0400 Subject: [PATCH] Add section to readme explaining address plugin --- ui-rsdir/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/ui-rsdir/README.md b/ui-rsdir/README.md index 7cfd4e3..0580bef 100644 --- a/ui-rsdir/README.md +++ b/ui-rsdir/README.md @@ -3,3 +3,23 @@ ## Introduction Front-end for the ReShare consortial directory + +## Address plugin configuration + +The address module uses `config.reshare.addressPlugin` from the Stripes +configuration to select the plugin used to edit and display addresses. Supported +values are `generic`, `north-america`, and `british-isles`. If the setting is +omitted or has an unrecognized value, the module uses the `generic` plugin. + +For example, the relevant section of `stripes.config.js` for the North American +address plugin is: + +```js +module.exports = { + config: { + reshare: { + addressPlugin: 'north-america', + }, + }, +}; +```