Merge pull request #21 from osm-search/dependabot/npm_and_yarn/lodash-4.17.19

[nominatim-ui.git] / README.md

diff --git a/README.md b/README.md
index 0f1d3e3f5a7e990fcb2a57c1c74db027f3acf75f..bd1748b51693dc5aa05b78a485e13c2b7e09fbbb 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,26 +1,45 @@
 # Nominatim-UI
 
-Frontend for [Nominatim](https://nominatim.org/) ([source](https://github.com/openstreetmap/Nominatim/)) geocoder.
+Debugging user interface for [Nominatim](https://nominatim.org/)
+([source](https://github.com/osm-search/Nominatim/)) geocoder.
+The frontend runs standalone as website and will requests data
+from a separate Nominatim API (either on the same server or
+remote).
 
-Preview version. See TODO file.
+For technical details see [CONTRIBUTING.md]() file.
 
-http://handlebarsjs.com/
+![Screenshot](screenshot.png)
 
+## Starting the frontend
 
-## Installation
+* You can open the `dist` directory in your browser.
 
-1. run build
+* If you have python installed (part of the Nominatim server installation):
 
-```
-./build.sh
-```
+   1. `cd dist`
+   2. start webserver `python3 -m http.server 8765` 
+   3. open [http://localhost:8765/]() in your browser
 
-2. start any webserver to serve static files, e.g.
+* 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
+
+Create a `dist/config.js` file, you can use `dist/config.example.js` as basis (just copy it). All settings are optional. Usually you want to set the `Nominatim_API_Endpoint` value at least.
+
+Defaults:
+
+| setting | default |
+|---|---|
+| `Nominatim_API_Endpoint` | http://localhost/nominatim/ (port 80) |
+| `Images_Base_Url` | images in [mapicons]() |
+| `Search_AreaPolygons` | yes, print boundaries of search results on map |
+| `Reverse_Default_Search_Zoom` | 18 (house-number level) |
+| `Map_Default_Lat`, `Map_Default_Lon`, `Map_Default_Zoom` | display whole world |
+| `Map_Tile_URL` | load from openstreetmap.org |
+| `Map_Tile_Attribution` | [OpenStreetMap](https://openstreetmap.org/copyright) obviously |
 
-```
-php -S localhost:8000 -t dist
-```
 
 ## License
 
-The source code is available under a GPLv2 license.
+The source code is available under a [GPLv2 license](LICENSE).