X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/6de0a854fb86cc3e19ee67743aa69f4a2c65b5e5..22bd9c4993ecb07d6c0b4f95d35c98bdfd98660d:/README.md

diff --git a/README.md b/README.md
index 5059473c..d5041d46 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
-[![Build Status](https://travis-ci.org/openstreetmap/Nominatim.svg?branch=master)](https://travis-ci.org/openstreetmap/Nominatim)
+[![Build Status](https://github.com/osm-search/Nominatim/workflows/CI%20Tests/badge.svg)](https://github.com/osm-search/Nominatim/actions?query=workflow%3A%22CI+Tests%22)
+[![codecov](https://codecov.io/gh/osm-search/Nominatim/branch/master/graph/badge.svg?token=8P1LXrhCMy)](https://codecov.io/gh/osm-search/Nominatim)
 
 Nominatim
 =========
@@ -6,23 +7,26 @@ 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), as well as an extensive [Troubleshooting/FAQ section](https://nominatim.org/release-docs/latest/admin/Faq/).
+
+[Detailed installation instructions for current master](https://nominatim.org/release-docs/develop/admin/Installation)
+can be found at nominatim.org as well.
+
+A quick summary of the necessary steps:
 
 1. Compile Nominatim:
 
@@ -30,20 +34,15 @@ Here is a quick summary of the necessary steps.
         cd build
         cmake ..
         make
+        sudo make install
 
-   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).
-
-2. Get OSM data and import:
-
-        ./build/utils/setup.php --osm-file <your planet file> --all
+2. Create a project directory, get OSM data and import:
 
-   Details can be found in [docs/Import_and_update.md](docs/Import-and-Update.md)
-
-3. Point your webserver to the ./build/website directory.
+        mkdir nominatim-project
+        cd nominatim-project
+        nominatim import --osm-file <your planet file>
 
+3. Point your webserver to the nominatim-project/website directory.
 
 
 License
@@ -51,11 +50,18 @@ License
 
 The source code is available under a GPLv2 license.
 
-Contact and Bug reports
-======================
 
-For questions you can join the geocoding mailinglist, see
-http://lists.openstreetmap.org/listinfo/geocoding
+Contributing
+============
+
+Contributions, bugreport and pull requests are welcome.
+For details see [contribution guide](CONTRIBUTING.md).
+
+
+Questions and help
+==================
 
-Bugs may be reported on the github project site:
-https://github.com/openstreetmap/Nominatim
+For questions, community help and discussions you can use the
+[Github discussions forum](https://github.com/osm-search/Nominatim/discussions)
+or join the
+[geocoding mailing list](https://lists.openstreetmap.org/listinfo/geocoding).