name-suggestion-index/DEVELOPING.md

Info for Developers

This file contains useful information for developers who want to use the name-suggestion-index in another project.

Downloading the index files

You can download the files from the index directly from GitHub or use a CDN.

Latest published release (stable forever):

Direct from GitHub _^(docs):

https://raw.githubusercontent.com/osmlab/name-suggestion-index/{branch or tag}/{path to file}
https://raw.githubusercontent.com/osmlab/name-suggestion-index/v5.0.20210315/dist/name-suggestions.presets.min.xml

Via JSDelivr CDN _^(docs):

https://cdn.jsdelivr.net/npm/name-suggestion-index@{semver}/{path to file}
https://cdn.jsdelivr.net/npm/name-suggestion-index@5.0/dist/name-suggestions.presets.min.xml

Current development version (breaks sometimes!):

Direct from GitHub _^(docs):

https://raw.githubusercontent.com/osmlab/name-suggestion-index/{branch or tag}/{path to file}
https://raw.githubusercontent.com/osmlab/name-suggestion-index/main/dist/presets/nsi-josm-presets.min.xml

Via JSDelivr CDN _^(docs):

https://cdn.jsdelivr.net/gh/name-suggestion-index@{branch or tag}/{path to file}
https://cdn.jsdelivr.net/gh/osmlab/name-suggestion-index@main/dist/presets/nsi-josm-presets.min.xml

Code

Some of the JavaScript code is available in both ES6 module (.mjs) and CommonJS (.js) formats.

More info soon.