detail page: fix display when keywords from API are empty (#153)

[nominatim-ui.git] / README.md

diff --git a/README.md b/README.md
index 0f1d3e3f5a7e990fcb2a57c1c74db027f3acf75f..687b879970d1a9ec7ab5d822914208a89b6c88e8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,26 +1,46 @@
 # Nominatim-UI
 
-Frontend for [Nominatim](https://nominatim.org/) ([source](https://github.com/openstreetmap/Nominatim/)) geocoder.
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/osm-search/nominatim-ui)
 
-Preview version. See TODO file.
+Debugging user interface for [Nominatim](https://nominatim.org/)
+([source](https://github.com/osm-search/Nominatim/)) geocoder.
 
-http://handlebarsjs.com/
+The frontend runs standalone as website and will request data
+from a separate Nominatim API running on http://localhost:80/nominatim/ (configurable, see below).
 
+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).
 
-## Installation
+![Screenshot](screenshot.png)
 
-1. run build
+## Starting the frontend
 
-```
-./build.sh
-```
+You can either
 
-2. start any webserver to serve static files, e.g.
+* open the `dist` directory in your browser.
 
+* 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
+
+* 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.
+
+
+## Configuration
+
+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`.
+
+The following `config.theme.js` example file changes the location of the API endpoint:
+
+```javascript
+  Nominatim_Config.Nominatim_API_Endpoint = 'http://my-server:1234/';
 ```
-php -S localhost:8000 -t dist
-```
+
+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).