moanos/Notfellchen
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Add section explaining geocoding

Browse Source
This commit is contained in:
moanos [he/him] 2024-05-31 11:55:39 +02:00
parent 677fc6626b
commit 0e05201f5a
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -38,3 +38,10 @@ docker build . -t moanos/notfellchen:latest
``` ```
docker run -p8000:7345 moanos/notfellchen:latest docker run -p8000:7345 moanos/notfellchen:latest
``` ```
## 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.