Leaflet/README.md

51 lines
1.7 KiB
Markdown

Leaflet
=======
Leaflet is a modern, lightweight BSD-licensed JavaScript library for making tile-based interactive maps for both desktop and mobile web browsers, developed by [CloudMade](http://cloudmade.com) to form the core of its next generation JavaScript API.
It is built from the ground up to work efficiently and smoothly on both platforms, utilizing cutting-edge technologies included in HTML5. Its top priorities are usability, performance and small size, [A-grade](http://developer.yahoo.com/yui/articles/gbs/) browser support, flexibility and easy to use API. The OOP-based code of the library is designed to be modular, extensible and very easy to understand.
## Contributing to Leaflet
Let's make the best open-source library for maps that can possibly exist! Please send your pull requests to [mourner](http://github.com/mourner) -- we'll be happy to accept your contributions!
## What's left to do for a feature-complete version
Overlays:
- GeoJSON, KML, GeoRSS layers
- mouse events in polylines, polygons and circles
Interaction:
- double tap on mobile webkit
- panning intertia on mobile webkit
Controls:
- control infrastructure (smart positioning)
- basic zoom control, zoom slider
- copyright control
Known issues to be fixed:
- flickering of vector layers on drag end under mobile webkit
## Browser support
On desktop:
- Firefox 3.6+
- Chrome
- Safari 5
- IE 7-9
- IE 6 (not perfect but accessible)
On mobile:
- Safari for iOS 3/4+
- WebKit for Android 2.2+
## Leaflet developers
Maintainer: [Vladimir Agafonkin](http://github.com/mourner), CloudMade
Contributors: (be the first!)