svelte 4.x => 5.0

[nominatim-ui.git] / README.md

diff --git a/README.md b/README.md
index 1d4d018e9df329272937e277d09c9cba317b76c5..46b87612eb16781719e9597ec63d9571c038ccb9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,13 +1,15 @@
 # Nominatim-UI
 
+![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.
 
 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)
 
@@ -25,15 +27,11 @@ You can either
 
 * 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.
 
+* to add the files into a nominatim-docker container see [README-nominatim-docker](README-nominatim-docker.md) file
 
 ## Configuration
 
-Defaults are set in `dist/config.default.js`.
-You can overwrite settings in `dist/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.