]> git.openstreetmap.org Git - nominatim.git/blob - packaging/nominatim-api/README.md
export UsageError and Configuration in api directly
[nominatim.git] / packaging / nominatim-api / README.md
1 Nominatim - frontend library
2 =========
3
4 Nominatim is a tool to search OpenStreetMap data
5 by name and address (geocoding) and to generate synthetic addresses of
6 OSM points (reverse geocoding).
7
8 This module implements the library for searching in a Nominatim database
9 imported with the `nominatim-db` package.
10
11 Documentation
12 =============
13
14 The documentation of the latest development version is in the
15 `docs/` subdirectory. A HTML version can be found at
16 https://nominatim.org/release-docs/develop/ .
17
18 License
19 =======
20
21 The source code is available under a GPLv3 license.