Add readme
Change-Id: I646de51fc0bcd728ca067469f260bc8b12baae63
diff --git a/LICENSE b/LICENSE
new file mode 100755
index 0000000..e983902
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,24 @@
+Copyright (c) 2015-2018, IDS Mannheim
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGE.
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d4ec78b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,68 @@
+# Kalamar-Plugin-ExternalProvider
+
+## Description
+
+Kalamar-Plugin-ExternalProvider is a web service that integrates in the plugin framework of
+[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
+demonstrate and evaluate the plugin capabilities of Kalamar.
+
+## Build
+
+To build the latest version of Kalamar-Plugin-ExternalProvider, do ...
+
+```shell
+$ git clone https://github.com/KorAP/Kalamar-Plugin-ExternalProvider
+$ cd Kalamar-Plugin-ExternalProvider
+$ go build .
+```
+
+## Running
+
+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
+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.
+
+## License
+
+Copyright (c) 2023, [IDS Mannheim](https://www.ids-mannheim.de/), Germany
+
+Kalamar-Plugin-ExternalProvider is developed as part of the
+[KorAP](https://korap.ids-mannheim.de/) Corpus Analysis Platform
+at the Leibniz Institute for the German Language
+([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).