v1.3.0 (December 7, 2015)

Project name change

This project is renamed to leaflet-geocoder-mapzen. Why did we do this?

This plugin was designed for "getting started" in mind. Most users have signed up for API keys with Mapzen Search and want to put a geocoder UI on their map application with a minimal amount of hassle. In the interest of keeping a clear distinguishing line between Mapzen Search (the hosted service with an API key) and Pelias (the open-source geocoding engine) we felt that naming the project this way would be less confusing. And we wanted to do it earlier rather than later.

This might qualify as a breaking change that would require a major version bump according to Semantic Versioning, but, there wouldn't be any new features added, so it would be a waste of a version number. You could think of this project as a fork or a separate project entirely, even though the repository has changed ownership to Mapzen to preserve things like issues and permissions.

The original project located at https://github.com/pelias/leaflet-geocoder, and its corresponding npm and bower packages, are now deprecated. There are placeholders there now to preserve functionality and to redirect users, but in the future, we will delete it.

To migrate from pelias-leaflet-geocoder to leaflet-geocoder-mapzen, here are the changes you should make (if they apply to your project):

Installing the package

• If installing from npm, update package.json to use the leaflet-geocoder-mapzen package instead of pelias-leaflet-geocoder.
• If installing from bower, update bower.json to use the leaflet-geocoder-mapzen package instead of pelias-leaflet-geocoder.
• If the package is downloaded directly from GitHub, update your scripts to refer to the repository at github.com/mapzen/leaflet-geocoder instead of github.com/pelias/leaflet-geocoder.

Linking to plugin files

Module loading systems

Since the package name has changed, you need to require() or import from the new package name.

Filenames in the dist/ folder have changed.

If you are linking to any of the files directly (like the stylesheet, for example), you'll need to update the filename references.

For example:

<link rel="stylesheet" href="pelias-leaflet-geocoder.css">
<script src="pelias-leaflet-geocoder.js"></script>

Becomes:

<link rel="stylesheet" href="leaflet-geocoder-mapzen.css">
<script src="leaflet-geocoder-mapzen.js"></script>

If you are referring to any hosted versions of these files, please update those links as well. (We have not encouraged this use case previously; better support will be announced in the future when the plugin can be hosted on a supported CDN.)

What about class names?

Despite the pelias prefix used throughout, updating class names now would probably be a headache for everyone. So there are no changes to class names. We may revisit this in v2 of the plugin.

Miscellaneous

Default attribution has been changed to "Geocoding by Mapzen" with a link to Mapzen Search.