]> git.openstreetmap.org Git - nominatim.git/blobdiff - docs/index.md
add getting started section for library docs
[nominatim.git] / docs / index.md
index 0ed6c54652e42e48fb693635031f814b78417b6c..b60a6d203a6c2fbb38dd91d8c9b386c9aca9c70a 100644 (file)
@@ -1,10 +1,12 @@
 Nominatim (from the Latin, 'by name') is a tool to search OSM data by name and address and to generate synthetic addresses of OSM points (reverse geocoding).
 
-This guide comes in four parts:
+This guide comes in five parts:
 
  * __[API reference](api/Overview.md)__ for users of Nominatim
  * __[Administration Guide](admin/Installation.md)__ for those who want
    to install their own Nominatim server
  * __[Customization Guide](customize/Overview.md)__ for those who want to
    adapt their own installation to their special requirements
+ * __[Library Guide](library/Getting-Started.md)__ for Python developers who
+   want to use Nominatim as a library in their project
  * __[Developer's Guide](develop/overview.md)__ for developers of the software