Skip to content

Commit 9f210d1

Browse files
authored
Add note on client config
1 parent 98fa1fe commit 9f210d1

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,18 @@ Each plugin handles a specific part of the data and is responsible for defining
2222

2323
## Configuration
2424

25+
### Client
26+
27+
See the client-specific instructions, such as configuring the server's STAC API, in the [README of the client package](../packages/client#client-specific-instructions).
28+
29+
### Plugins
30+
2531
STAC-Manager's [config file](/packages/client/src/plugin-system/config.ts) specifies the plugins that the app uses for Collections and Items while extending the `Default Plugin Widget Configuration` which defines the widgets for the basic field types.
2632
_See the [data-widgets/config](/packages/data-widgets/lib/config/index.ts) for a list of existent widgets._
2733

2834
When creating a new plugin or a new widget, the configuration should be updated with the new plugin/widget.
2935

30-
### Example config
36+
#### Example config
3137

3238
The config object should contain a list of plugins to use for the collections and items, as well as the widget configuration (which widgets to use for which field types).
3339

0 commit comments

Comments
 (0)