diff --git a/docs/assets/img/geosearch.gif b/docs/assets/img/geosearch.gif new file mode 100644 index 00000000..a90f5863 Binary files /dev/null and b/docs/assets/img/geosearch.gif differ diff --git a/docs/assets/img/screenshot.png b/docs/assets/img/screenshot.png new file mode 100644 index 00000000..8f5ca626 Binary files /dev/null and b/docs/assets/img/screenshot.png differ diff --git a/docs/introduction.mdx b/docs/introduction.mdx index 25202c45..38b1cf64 100644 --- a/docs/introduction.mdx +++ b/docs/introduction.mdx @@ -11,7 +11,7 @@ import Map from './components/Map'; `leaflet-geosearch` adds support for geocoding (address lookup, a.k.a. geoseaching) to your (web) application. It comes with controls to be embedded in your Leaflet map. -We support the following providers out-of-the-box; [Bing](/providers/bing), [Esri](/providers/esri), [Google](/providers/google), [OpenStreetMap](/providers/openstreetmap), [LocationIQ](/providers/locationiq), [OpenCage](/providers/opencage). +We support the following providers out-of-the-box; [Algolia](./providers/algolia), [Bing](./providers/bing), [Esri](./providers/esri), [Google](./providers/google), [OpenStreetMap](./providers/openstreetmap), [LocationIQ](./providers/locationiq), [OpenCage](./providers/opencage). Although this project is named `leaflet-geosearch`, this library is also usable without LeafletJS, and does not have any dependencies on Leaflet whatsoever. @@ -85,7 +85,7 @@ map.addControl(search); `leaflet-geosearch` uses so-called "providers" to take care of building the correct service URL and parsing the retrieved data into a uniform format. Thanks to this architecture, it is trivial to add your own providers, so you can use your own geocoding service. -When [`OpenStreetMap`](/providers/openstreet) does not match your needs; you can also choose to use the [`Bing`](/providers/bing), [`Esri`](/providers/esri), [`Google`](/providers/google), [`LocationIQ`](/providers/locationiq), or [`OpenCage`](/providers/opencage) providers. Most of those providers do however require `API keys`. See the documentation pages on the relevant organisations on how to obtain these keys. +When [`OpenStreetMap`](./providers/openstreet) does not match your needs; you can also choose to use the [Algolia](./providers/algolia), [`Bing`](./providers/bing), [`Esri`](./providers/esri), [`Google`](./providers/google), [`LocationIQ`](./providers/locationiq), or [`OpenCage`](./providers/opencage) providers. Most of those providers do however require `API keys`. See the documentation pages on the relevant organisations on how to obtain these keys. In case you decide to write your own provider, please consider submitting a PR to share your work with us. diff --git a/readme.md b/readme.md index 86c9439f..b88fb8a5 100644 --- a/readme.md +++ b/readme.md @@ -1,19 +1,13 @@ -## LOOKING FOR MAINTAINERS - -See: [#172](https://github.com/smeijer/leaflet-geosearch/issues/172) for more info. - ---- - # Leaflet.GeoSearch -[![Join the chat at https://gitter.im/smeijer/leaflet-geosearch](https://badges.gitter.im/smeijer/leaflet-geosearch.svg)](https://gitter.im/smeijer/leaflet-geosearch?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +**Demo and Docs: [smeijer.github.io/leaflet-geosearch](https://smeijer.github.io/leaflet-geosearch)** -[![build status](https://img.shields.io/travis/smeijer/leaflet-geosearch/master.svg?style=flat-square)][9] - -[![NPM](https://nodei.co/npm/leaflet-geosearch.png?downloads=true)][10] +![animation of geosearch](./docs/assets/img/geosearch.gif) ## Installation +**more docs @** https://smeijer.github.io/leaflet-geosearch/#installation + with npm: ```bash @@ -26,70 +20,44 @@ or yarn: yarn add leaflet-geosearch ``` -or bower: - -```bash -bower install leaflet-geosearch -``` - -**TypeScript** - -If you use TypeScript then consider to install types: - -```bash -npm install --save-dev @types/leaflet-geosearch -``` - -or yarn: - -```bash -yarn add @types/leaflet-geosearch -D -``` - ---- - -If you don’t use [npm][11], you may grab the latest [UMD][12] build from -[unpkg][13] (either a [development][14] or a [production][15] build). The UMD build -exports a global called `window.GeoSearch` if you add it to your page via a -`