X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/fa1c402b47bdd1f76b8528885c0e3a5e90731cdc..ecf4693a799055b3795ca691337941f931cf0a59:/packaging/nominatim-api/README.md diff --git a/packaging/nominatim-api/README.md b/packaging/nominatim-api/README.md index a0d43ade..9dddbdc2 100644 --- a/packaging/nominatim-api/README.md +++ b/packaging/nominatim-api/README.md @@ -4,8 +4,8 @@ Nominatim is a tool to search OpenStreetMap data by name and address (geocoding) and to generate synthetic addresses of OSM points (reverse geocoding). -This module implements the library for searching in a Nominatim database -imported with the 'nominatim-db' package. +This module implements the library for searching a Nominatim database +imported with the [`nominatim-db`](https://pypi.org/project/nominatim-db/) package. ## Installation @@ -15,7 +15,7 @@ To install the Nominatim API from pypi, run: ## Running a Nominatim server -You need falcon or starlette to run Nominatim as a service, as well as +You need Falcon or Starlette to run Nominatim as a service, as well as an ASGI-capable server like uvicorn. To install them from pypi run: pip install falcon uvicorn @@ -28,10 +28,10 @@ package. Go to the project directory, then run uvicorn as: ## Documentation The full documentation for the Nominatim library can be found at: -https://nominatim.org/release-docs/develop/library/Getting-Started/ +https://nominatim.org/release-docs/latest/library/Getting-Started/ The v1 API of the server is documented at: -https://nominatim.org/release-docs/develop/api/Overview/ +https://nominatim.org/release-docs/latest/api/Overview/ ## License