From 0e05201f5a393cddb3e3437fe007904beede8430 Mon Sep 17 00:00:00 2001 From: moanos Date: Fri, 31 May 2024 11:55:39 +0200 Subject: [PATCH] docs: Add section explaining geocoding --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2b43e8d..7b606e7 100644 --- a/README.md +++ b/README.md @@ -37,4 +37,11 @@ docker build . -t moanos/notfellchen:latest ``` docker run -p8000:7345 moanos/notfellchen:latest -``` \ No newline at end of file +``` + +## Geocoding + +Geocoding services (search map data by name, address or postcode) are provided via the +[Nominatim](https://nominatim.org/) API, powered by [OpenStreetMap](https://openstreetmap.org) data. Notfellchen uses +a selfhosted Nominatim instance to avoid overburdening the publicly hosted instance. Due to ressource constraints +geocoding is only supported for Germany right now. \ No newline at end of file