UI: update the switch-to-reverse link after each map click

[nominatim.git] / README.md

diff --git a/README.md b/README.md
index c3f4a3d5263d17e9f1d6bb08b7ebe8f4766f87b7..7e8c776ef94fb3080b4973e909bd8acaa6a932a1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,59 +1,63 @@
+[![Build Status](https://travis-ci.org/openstreetmap/Nominatim.svg?branch=master)](https://travis-ci.org/openstreetmap/Nominatim)
+
 Nominatim
 =========
 
 Nominatim (from the Latin, 'by name') is a tool to search OpenStreetMap data
 by name and address (geocoding) and to generate synthetic addresses of
 OSM points (reverse geocoding). An instance with up-to-date data can be found
-at http://nominatim.openstreetmap.org. Nominatim is also used as one of the
-sources for the Search box on the OpenStreetMap home page and powers the search
-on the MapQuest Open Initiative websites.
+at https://nominatim.openstreetmap.org. Nominatim is also used as one of the
+sources for the Search box on the OpenStreetMap home page.
 
 Documentation
 =============
 
-More information about Nominatim, including usage and installation instructions,
-can be found in the docs/ subdirectory and in the OSM wiki at:
-
-http://wiki.openstreetmap.org/wiki/Nominatim
+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/ .
 
 Installation
 ============
 
-There are detailed installation instructions in the /docs directory.
-Here is a quick summary of the necessary steps.
+The latest stable release can be downloaded from https://nominatim.org.
+There you can also find [installation instructions for the release](https://nominatim.org/release-docs/latest/admin/Installation).
 
-1. Compile Nominatim:
+Detailed installation instructions for the development version can be
+found at [nominatim.org](https://nominatim.org/release-docs/develop/admin/Installation)
+as well.
+
+A quick summary of the necessary steps:
 
-     mkdir build
-     cd build
-     cmake ..
-     make
+1. Compile Nominatim:
 
-   For more detailed installation instructions see [docs/Installation.md](docs/Installation.md).
-   There are also step-by-step instructions for
-     [Ubuntu 16.04](docs/install-on-ubuntu-16.md) and
-     [CentOS 7.2](docs/install-on-centos-7.md).
+        mkdir build
+        cd build
+        cmake ..
+        make
 
 2. Get OSM data and import:
 
-     ./build/utils/setup.php --osm-file <your planet file> --all
-
-   Details can be found in [docs/Import_and_update.md](docs/Import_and_update.md)
+        ./build/utils/setup.php --osm-file <your planet file> --all
 
 3. Point your webserver to the ./build/website directory.
 
 
-
 License
 =======
 
 The source code is available under a GPLv2 license.
 
-Contact and Bugreports
-======================
 
-For questions you can join the geocoding mailinglist, see
-http://lists.openstreetmap.org/listinfo/geocoding
+Contributing
+============
+
+Contributions are welcome. For details see [contribution guide](CONTRIBUTING.md).
+
+Both bug reports and pull requests are welcome.
+
 
-Bugs may be reported on the github project site:
-https://github.com/twain47/Nominatim
+Mailing list
+============
+
+For questions you can join the geocoding mailinglist, see
+https://lists.openstreetmap.org/listinfo/geocoding