Add JSON manifest to README
Change-Id: Iae7da8f61818878986acdf842d75bbe2ec0b9698
diff --git a/README.md b/README.md
index 684e889..593ed62 100644
--- a/README.md
+++ b/README.md
@@ -321,6 +321,30 @@
Health check endpoint. Returns `OK` with HTTP 200.
+## Kalamar Plugin Registration
+
+To register Koral-Mapper as a Kalamar plugin, a JSON manifest must be provided to the Kalamar plugin system. The manifest specifies how the plugin is embedded and what permissions it requires. For example:
+
+```json
+{
+ "name": "Koral-Mapper",
+ "desc": "Rewrites annotation terms in queries and responses",
+ "embed": [{
+ "panel": "query",
+ "title": "Term Mapper Configuration",
+ "icon": "\uf074",
+ "classes": ["button-icon", "plugin"],
+ "onClick": {
+ "action": "addWidget",
+ "template": "https://korap.ids-mannheim.de/plugin/koralmapper/",
+ "permissions": ["scripts", "forms", "same-origin"]
+ }
+ }]
+}
+```
+
+Adjust the `template` URL to match your deployment's `serviceURL`.
+
## Supported Mappings
### `mappings/stts-upos.yaml`