Change port env and improve readme.
Change-Id: Ib4248b0aa83ac2d7ede30bbc594a722958d8272e
diff --git a/README.md b/README.md
index 0ffd983..ed41414 100644
--- a/README.md
+++ b/README.md
@@ -6,9 +6,13 @@
[Kalamar](https://github.com/KorAP/Kalamar), to allow linking texts by their text sigle
to external data providers, mainly for full text access.
-Kalamar-Plugin-Export is meant to be a basic export plugin and should
+Kalamar-Plugin-ExternalProvider is meant to be a basic plugin and should
demonstrate and evaluate the plugin capabilities of Kalamar.
+## Prerequisites
+
+Go 1.19 or later
+
## Build
To build the latest version of Kalamar-Plugin-ExternalProvider, do ...
@@ -16,6 +20,7 @@
```shell
$ git clone https://github.com/KorAP/Kalamar-Plugin-ExternalProvider
$ cd Kalamar-Plugin-ExternalProvider
+$ go test .
$ go build .
```
@@ -24,41 +29,22 @@
The binary can be started without prerequisites. The `templates` folder has to be kept in the root directory.
Registration of the plugin in Kalamar is not yet officially supported.
-Registration works by passing the following JSON blob
+Registration works by passing the JSON blob generated at `/plugin.json`
to the plugin registration handler.
-```json
-{
- "name" : "External Provider",
- "desc" : "Buy content from an external provider",
- "embed" : [{
- "panel" : "match",
- "title" : "Full Text",
- "classes" : ["cart"],
- "onClick" : {
- "action" : "addWidget",
- "template" : "{SERVICE_URL}",
- "permissions": [
- "scripts",
- "popups"
- ]
- }
- }]
-}
-```
-
## Customization
The following environment variables can be set either as environment variables
or via `.env` file.
- `KORAP_SERVER`: The server URL of the hosting service.
-- `PORT`: The port the service should be listen to.
-- `KORAP_EXTERNAL_PROVIDER`: The URL the service is hosted.
+- `KORAP_EXTERNAL_PROVIDER_PORT`: The port the service should be listen to.
+- `KORAP_EXTERNAL_PROVIDER`: The exposed URL the service is hosted.
## License
-Copyright (c) 2023, [IDS Mannheim](https://www.ids-mannheim.de/), Germany
+Copyright (c) 2023, [IDS Mannheim](https://www.ids-mannheim.de/), Germany<br>
+Author: [Nils Diewald](https://www.nils-diewald.de/)
Kalamar-Plugin-ExternalProvider is developed as part of the
[KorAP](https://korap.ids-mannheim.de/) Corpus Analysis Platform
@@ -66,4 +52,4 @@
([IDS](https://www.ids-mannheim.de/)).
Kalamar-Plugin-ExternalProvider is published under the
-[BSD-2 License](https://raw.githubusercontent.com/KorAP/Kalamar-Plugin-Export/master/LICENSE).
+[BSD-2 License](https://raw.githubusercontent.com/KorAP/Kalamar-Plugin-ExternalProvider/master/LICENSE).