Merge pull request #3491 from mtmail/faq-unicode-encoding

[nominatim.git] / packaging / nominatim-api / README.md

diff --git a/packaging/nominatim-api/README.md b/packaging/nominatim-api/README.md
index 2711e50e16778214fdebc072da97397eac0b6957..9dddbdc2f137cb53bdec8d09138d0e06a0e411e0 100644 (file)
--- a/packaging/nominatim-api/README.md
+++ b/packaging/nominatim-api/README.md
@@ -1,21 +1,38 @@
-Nominatim - frontend library
-=========
+# Nominatim - Frontend Library
 
 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.
 
-Documentation
-=============
+## Installation
 
-The documentation of the latest development version is in the
-`docs/` subdirectory. A HTML version can be found at
-https://nominatim.org/release-docs/develop/ .
+To install the Nominatim API from pypi, run:
 
-License
-=======
+    pip install nominatim-api
+
+## Running a Nominatim server
+
+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
+
+You need to have a Nominatim database imported with the 'nominatim-db'
+package. Go to the project directory, then run uvicorn as:
+
+    uvicorn --factory nominatim.server.falcon.server:run_wsgi
+
+## Documentation
+
+The full documentation for the Nominatim library can be found at:
+https://nominatim.org/release-docs/latest/library/Getting-Started/
+
+The v1 API of the server is documented at:
+https://nominatim.org/release-docs/latest/api/Overview/
+
+## License
 
 The source code is available under a GPLv3 license.