convert mocha and eslint configuration to json file

[nominatim-ui.git] / README.md

diff --git a/README.md b/README.md
index 2acb5ba8d10cbfac38556e5bd52964722a538551..fa4f021d385c43a79bf4989ffb875d54fb8f633c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,56 +1,40 @@
 # Nominatim-UI
 
 # 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
 
 
 ## Starting the frontend
 

-You can open the `dist` directory in your browser.
-
-You can run `yarn start` to start a simple HTTP webserver and open
-[http://localhost:8000/]() in your browser.
+You can either

 
 

-Or start another webserver ([Big list of http static server one-liners](https://gist.github.com/willurd/5720255)).
+* open the `dist` directory in your browser.

 
 

+* if you have Python installed (part of the Nominatim API server installation):

 
 

-## Configuration
-
-In `dist/config.js` you will find configuration options. The first
-you want to doublecheck is the `Nominatim_API_Endpoint` URL.
+   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.

 
 

-## Building the frontend

 
 

-* Install dependencies
-
-   ```
-   yarn install
-   ```
+## Configuration

 
 

-* After you change files in `src` directory
+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.

 
 

-   ```
-   yarn build
-   ```
+The `dist/theme/` directory also contains files make it easy to set a different
+logo image, colors, welcome and help text.

 
 ## License
 
 
 ## License
 

-The source code is available under a GPLv2 license.
+The source code is available under a [GPLv2 license](LICENSE).