Add readme to start examole image
Change-Id: Iafbc3ad8831e2f751ae699abbae3baec0c14770e
diff --git a/Readme.md b/Readme.md
index 551a67b..871cad7 100644
--- a/Readme.md
+++ b/Readme.md
@@ -25,12 +25,17 @@
## Starting
-To get KorAP running, an existing index is required.
-For testing, either download the sample index provided by
-[Kustvakt](https://github.com/KorAP/Kustvakt/tree/master/sample-index)
-or first follow the instructions on [Corpus Conversion](#corpus-conversion).
+To get KorAP running, an index is required.
+For testing, there is a test index available as a docker image. Just run
-To download, intialize and run KorAP pointing to that existing index
+```
+$ INDEX='example-index' docker-compose -p korap --profile=lite --profile=example up
+```
+
+to start the example image.
+Otherwise it's possible to download the sample index provided by
+[Kustvakt](https://github.com/KorAP/Kustvakt/tree/master/sample-index).
+To download, intialize and run KorAP pointing to that index folder
(in this example stored in the `index` folder in the local directory),
run
@@ -41,6 +46,9 @@
This will make the frontend be available at
`localhost:64543`.
+To use your own index, please follow the instructions
+on [Corpus Conversion](#corpus-conversion) first.
+
To run the service with an additional user management system,
initialize with
diff --git a/compose.yaml b/compose.yaml
index 5f4c730..64e785d 100644
--- a/compose.yaml
+++ b/compose.yaml
@@ -3,7 +3,7 @@
example-index:
services:
examplecontainer:
- image: "korap/example-index:latest"
+ image: "korap/example-index:0.1"
profiles:
- example
volumes: