From deb4542097fd790a7629e09236a648a38a525fac Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jan=20Bedna=C5=99=C3=ADk?= <jan.bednarik@gmail.com>
Date: Thu, 23 Nov 2017 00:55:38 +0100
Subject: [PATCH] Update readme.
---
Makefile | 13 +++++++++++++
README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 71 insertions(+)
diff --git a/Makefile b/Makefile
index b5f2393..a6628af 100644
--- a/Makefile
+++ b/Makefile
@@ -1,5 +1,18 @@
+run:
+ docker-compose up -d
+
+stop:
+ docker-compose down
+
+destroy:
+ docker-compose down -v
+
build:
docker build -t openlobby/openlobby-es-czech:latest .
push:
docker push openlobby/openlobby-es-czech:latest
+
+release:
+ make build
+ make push
diff --git a/README.md b/README.md
index 7325ea1..4c266e9 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,60 @@
# Elasticsearch with Czech analyzer
+Batteries included:
+ - ICU Analysis Plugin
+ - Czech Hunspell dictionaries (from OpenOffice)
+
+X-Pack plugin is removed.
+
+## Usage
+
+Create your index with these settings:
+
+```
+{
+ 'settings': {
+ 'analysis': {
+ 'filter': {
+ 'czech_stop': {
+ 'type': 'stop',
+ 'stopwords': '_czech_',
+ },
+ 'czech_stemmer': {
+ 'type': 'stemmer',
+ 'language': 'czech',
+ },
+ 'cs_CZ': {
+ 'type': 'hunspell',
+ 'locale': 'cs_CZ',
+ 'dedup': True,
+ }
+ },
+ 'analyzer': {
+ 'czech': {
+ 'tokenizer': 'standard',
+ 'filter': [
+ 'icu_folding',
+ 'lowercase',
+ 'czech_stop',
+ 'czech_stemmer',
+ 'cs_CZ',
+ ]
+ }
+ }
+ }
+ }
+}
+```
+
+You can use `'czech'` analyzer on text fields now.
+
+## Build
+
+Build docker container: `make build`
+
+## Run for local development
+
+Run Elasticsearch on port 9200: `make run`
+Stop Elasticsearch container: `make stop`
+
+Stop and/or remove volume with data: `make destroy`
--
GitLab