Merge remote-tracking branch 'upstream/master'

[nominatim-ui.git] / README.md

diff --git a/README.md b/README.md
index 1cfa5e7b4bb7106ebafad8799c193786ed2e72e0..687b879970d1a9ec7ab5d822914208a89b6c88e8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,57 +1,46 @@
 # Nominatim-UI
 
-Debugging user interface for [Nominatim](https://nominatim.org/)
-([source](https://github.com/openstreetmap/Nominatim/)) geocoder.
-The frontend runs standalone as website and will requests data
-from a separate Nominatim API (either on the same server or
-remote).
-
-Uses [jQuery](https://jquery.com/) for browser DOM interaction,
-[handlebar](http://handlebarsjs.com/) templates to build pages,
-[leaflet](https://leafletjs.com/) for map interaction,
-[bootstrap](https://getbootstrap.com/) for layout styling.
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/osm-search/nominatim-ui)
 
+Debugging user interface for [Nominatim](https://nominatim.org/)
+([source](https://github.com/osm-search/Nominatim/)) geocoder.
 
-## Background
+The frontend runs standalone as website and will request data
+from a separate Nominatim API running on http://localhost:80/nominatim/ (configurable, see below).
 
-The user interface used to be included in the geocoder. Thus the
-first version avoid being a redesign and still uses some of the
-same configuration values. For simplicity it's not a single
-page application (SPA) written in a framework though it could
-be if complexity grows.
+Download a stable release from [https://github.com/osm-search/nominatim-ui/releases](https://github.com/osm-search/nominatim-ui/releases).
+For technical background, how to develop and create a release see [CONTRIBUTE.md](CONTRIBUTE.md) file at [https://github.com/osm-search/nominatim-ui/](https://github.com/osm-search/nominatim-ui).
 
+![Screenshot](screenshot.png)
 
 ## Starting the frontend
 
-You can open the `dist` directory in your browser.
+You can either
 
-You can start a simple HTTP webserver ([Big list of http static server one-liners](https://gist.github.com/willurd/5720255)).
+* open the `dist` directory in your browser.
 
-```
-php -S 0.0.0.0:8000 -t dist
-```
+* if you have Python installed (part of the Nominatim API server installation):
 
+   1. `cd dist`
+   2. start webserver `python3 -m http.server 8765` 
+   3. open [http://localhost:8765/]() in your browser
 
-## Configuration
-
-In `dist/config.js` you will find configuration options. The first
-you want to doublecheck is the `Nominatim_API_Endpoint` URL.
+* start a webserver using ([Big list of http static server one-liners](https://gist.github.com/willurd/5720255)) or configure Apache, nginx or other webservers to serve the `dist` directory.
 
 
-## Building the frontend
+## Configuration
 
-* Install dependencies
+You can customize your installation by creating and editing `dist/theme/config.theme.js` which allows you to override the default values provided by `dist/config.default.js`.
 
-   ```
-   yarn install
-   ```
+The following `config.theme.js` example file changes the location of the API endpoint:
 
-* After you change files in `src` directory
+```javascript
+  Nominatim_Config.Nominatim_API_Endpoint = 'http://my-server:1234/';
+```
 
-   ```
-   ./build.sh
-   ```
+The `dist/theme/` directory also contains files make it easy to set a different
+logo image, colors, welcome and help text.
 
 ## License
 
-The source code is available under a GPLv2 license.
+The source code is available under a [GPLv2 license](LICENSE).