]> git.openstreetmap.org Git - nominatim-ui.git/blobdiff - README.md
Fix syntax of config example
[nominatim-ui.git] / README.md
index eccd33c79a6364c987d68fa24451af4f14504341..fa4f021d385c43a79bf4989ffb875d54fb8f633c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,8 +8,8 @@ Debugging user interface for [Nominatim](https://nominatim.org/)
 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]().
-For technical background, how to develop and create a release see [CONTRIBUTE.md](CONTRIBUTE.md) file at [https://github.com/osm-search/nominatim-ui/]().
+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)
 
@@ -30,12 +30,7 @@ You can either
 
 ## Configuration
 
-Defaults are set in `dist/config.default.js`.
-You can overwrite settings in `dist/theme/config.theme.js`, for example:
-
-```javascript
-  Nominatim_Config.Nominatim_API_Endpoint = 'http://my-server:1234/';
-```
+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`. See the `config.theme.js.example` in the same directory for examples.
 
 The `dist/theme/` directory also contains files make it easy to set a different
 logo image, colors, welcome and help text.