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
## 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
## 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