]> git.openstreetmap.org Git - nominatim.git/blobdiff - packaging/nominatim-api/README.md
derive bbox size for postcode nodes from rank_search
[nominatim.git] / packaging / nominatim-api / README.md
index a0d43ade07fa0e951238779c92fd4fcd248f7613..9dddbdc2f137cb53bdec8d09138d0e06a0e411e0 100644 (file)
@@ -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