add missing includes in result fomatting example

[nominatim.git] / docs / index.md

diff --git a/docs/index.md b/docs/index.md
index 41eadde1fbb89f1c9b28e2e4d5da5b5b583760bd..0b479a17f7bfacc2b4939049a03876752d147b48 100644 (file)
--- a/docs/index.md
+++ b/docs/index.md
@@ -1 +1,15 @@
-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).
+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).
+It has also limited capability to search features by their type
+(pubs, hotels, churches, etc).
+
+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