From b4f91157e33b74c22f6de1124984a3e480f0f1c2 Mon Sep 17 00:00:00 2001 From: bolollo Date: Mon, 18 Aug 2025 14:30:08 +0200 Subject: [PATCH 1/4] CU-1131 update readme add related links --- README.md | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 308ab47..4acb935 100644 --- a/README.md +++ b/README.md @@ -18,21 +18,29 @@ # MapTiler Geocoding control for MapTiler SDK, MapLibre GL JS, Leaflet and OpenLayers +## What ? + +The *MapTiler Geocoding control* implements a powerful search box in your maps or online forms, enabling your application users to find any place on Earth down to individual addresses. Use the search box control with [MapTiler SDK JS](https://docs.maptiler.com/sdk-js/) (or other map libraries like [Leaflet](https://docs.maptiler.com/leaflet/), [MapLibre GL JS](https://github.com/maplibre/maplibre-gl-js), [OpenLayers](https://docs.maptiler.com/openlayers/)). + ## About -A _Geocoding control_ for [MapTiler SDK](https://github.com/maptiler/maptiler-sdk-js), -[MapLibre GL JS](https://github.com/maplibre/maplibre-gl-js), -[Leaflet](https://leafletjs.com) and [OpenLayers](https://openlayers.org) utilizes [MapTiler Cloud Geocoding -API](https://www.maptiler.com/cloud/geocoding/). With this control, users of -mapping application can find any place on Earth (States, Cities, Streets, Addresses, POIs, ...) down -to the address level, restrict the search area to a specific country, highlight -searched results on the map, autocomplete words while typing, and much more. +The _Geocoding control_ uses the [MapTiler Geocoding API](https://www.maptiler.com/cloud/geocoding/). You can use the API directly from your web or backend applications or use the [API Client JS](https://docs.maptiler.com/client-js/) library. + +With this control, users of +mapping application can: + +* Find any place on Earth (States, Cities, Streets, Addresses, POIs, ...) down +to the address level +* Restrict the search area to a specific country, bounding box, or proximity +* Highlight searched results on the map (marker or full geometry) +* Autocomplete words while typing +* and much more. Check out the [Geocoding Control API reference](https://docs.maptiler.com/sdk-js/modules/geocoding/api/api-reference/#options) to see all the options. The component can be used as an ES module or UMD module with or without bundler. Geocoding control is also provided as [React component](https://docs.maptiler.com/sdk-js/modules/geocoding/api/usage/react/) and [Svelte component](https://docs.maptiler.com/sdk-js/modules/geocoding/api/usage/svelte/) and [other libraries](#installation-and-more-usage-examples). -## Quick start +## Install Install the Geocoding control unsing `npm`: @@ -46,6 +54,8 @@ If you are using a this library in a Svelte project you can npm install with `-- npm install --save @maptiler/geocoding-control @maptiler/sdk ``` +## Quick start + Use the component in your mapping application: ```js From 0a2a6caf06a8959f680a18f630047232c2a0c32c Mon Sep 17 00:00:00 2001 From: bolollo Date: Mon, 18 Aug 2025 14:33:10 +0200 Subject: [PATCH 2/4] CU-1131 Update sections titles --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4acb935..712b02c 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,11 @@ # MapTiler Geocoding control for MapTiler SDK, MapLibre GL JS, Leaflet and OpenLayers -## What ? +## What? The *MapTiler Geocoding control* implements a powerful search box in your maps or online forms, enabling your application users to find any place on Earth down to individual addresses. Use the search box control with [MapTiler SDK JS](https://docs.maptiler.com/sdk-js/) (or other map libraries like [Leaflet](https://docs.maptiler.com/leaflet/), [MapLibre GL JS](https://github.com/maplibre/maplibre-gl-js), [OpenLayers](https://docs.maptiler.com/openlayers/)). -## About +## Why? The _Geocoding control_ uses the [MapTiler Geocoding API](https://www.maptiler.com/cloud/geocoding/). You can use the API directly from your web or backend applications or use the [API Client JS](https://docs.maptiler.com/client-js/) library. From 4a69eb8c1f7a451500a7fddef80394761ad930bf Mon Sep 17 00:00:00 2001 From: bolollo Date: Mon, 18 Aug 2025 14:37:02 +0200 Subject: [PATCH 3/4] CU-1131 Update title --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 712b02c..d1b8e83 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@

-# MapTiler Geocoding control for MapTiler SDK, MapLibre GL JS, Leaflet and OpenLayers +# MapTiler Search and Geocoding control for MapTiler SDK, MapLibre GL JS, Leaflet and OpenLayers ## What? From e724b0bc899c5c479a4befbc22ddf0242ddadc7f Mon Sep 17 00:00:00 2001 From: bolollo Date: Mon, 25 Aug 2025 18:59:23 +0200 Subject: [PATCH 4/4] CU-1131 add reverse geocoding --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index d1b8e83..82b957f 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,7 @@ mapping application can: * Find any place on Earth (States, Cities, Streets, Addresses, POIs, ...) down to the address level +* Find and identify objects or place names using a coordinate pair or a single mouse click (reverse geocoding) * Restrict the search area to a specific country, bounding box, or proximity * Highlight searched results on the map (marker or full geometry) * Autocomplete words while typing