Skip to content

Commit 8fb6daf

Browse files
authored
CU-1131 update readme add related links (#97)
* CU-1131 update readme add related links * CU-1131 Update sections titles * CU-1131 Update title * CU-1131 add reverse geocoding
1 parent d001f38 commit 8fb6daf

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,32 @@
1616
<img src="https://img.shields.io/twitter/follow/maptiler?style=social"></img>
1717
</p>
1818

19-
# MapTiler Geocoding control for MapTiler SDK, MapLibre GL JS, Leaflet and OpenLayers
19+
# MapTiler Search and Geocoding control for MapTiler SDK, MapLibre GL JS, Leaflet and OpenLayers
2020

21-
## About
21+
## What?
2222

23-
A _Geocoding control_ for [MapTiler SDK](https://github.com/maptiler/maptiler-sdk-js),
24-
[MapLibre GL JS](https://github.com/maplibre/maplibre-gl-js),
25-
[Leaflet](https://leafletjs.com) and [OpenLayers](https://openlayers.org) utilizes [MapTiler Cloud Geocoding
26-
API](https://www.maptiler.com/cloud/geocoding/). With this control, users of
27-
mapping application can find any place on Earth (States, Cities, Streets, Addresses, POIs, ...) down
28-
to the address level, restrict the search area to a specific country, highlight
29-
searched results on the map, autocomplete words while typing, and much more.
23+
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/)).
24+
25+
## Why?
26+
27+
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.
28+
29+
With this control, users of
30+
mapping application can:
31+
32+
* Find any place on Earth (States, Cities, Streets, Addresses, POIs, ...) down
33+
to the address level
34+
* Find and identify objects or place names using a coordinate pair or a single mouse click (reverse geocoding)
35+
* Restrict the search area to a specific country, bounding box, or proximity
36+
* Highlight searched results on the map (marker or full geometry)
37+
* Autocomplete words while typing
38+
* 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.
3039

3140
The component can be used as an ES module or UMD module with or without bundler.
3241

3342
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).
3443

35-
## Quick start
44+
## Install
3645

3746
Install the Geocoding control unsing `npm`:
3847

@@ -46,6 +55,8 @@ If you are using a this library in a Svelte project you can npm install with `--
4655
npm install --save @maptiler/geocoding-control @maptiler/sdk
4756
```
4857

58+
## Quick start
59+
4960
Use the component in your mapping application:
5061

5162
```js

0 commit comments

Comments
 (0)