Added README.MD

README.MD

@@ -0,0 +1,28 @@
+##Stemmer string distance service
+Usługa jest odpowiedzielna za obliczenie dystansu pomiędzy dwoma łańcuchami znaków.
+Użyta miara odległości to tzw. [IoU (Jaccard Index)](https://en.wikipedia.org/wiki/Jaccard_index).
+
+Przed porównaniem oba łańcuchy znaków są poddane działaniu Polskiego stemmingu.
+W tym celu użyto implementacji stemmingu pochodzącej [stąd](https://github.com/dzieciou/pystempel).
+
+Zasób jest dostępny pod domyślym adresem `http://localhost:5000/stemmer-distance`
+
+### Instalacja zależności
+
+Zależności są wymienione w pliku `requirements.txt`
+```shell script
+pip3 install -r requirements.txt
+```
+
+### Uruchamianie aplikacji
+
+```shell script
+python3 app.py
+```
+
+**Zmienne środowiskowe**
+```
+FLASK_ENV=development/production
+FLASK_DEBUG=0/1
+```
+