Leaflet/README.md

52 lines
1.7 KiB
Markdown
Raw Normal View History

2010-09-23 19:16:31 +08:00
Leaflet
=======
2011-03-28 23:02:37 +08:00
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.
2010-09-23 16:57:14 +08:00
2011-03-28 23:02:37 +08:00
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.
2010-09-23 16:57:14 +08:00
## Contributing to Leaflet
2011-03-28 20:51:05 +08:00
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!
2010-09-23 23:44:14 +08:00
2010-09-25 22:25:41 +08:00
## What's left to do for a feature-complete version
2010-09-23 23:47:38 +08:00
2011-03-02 00:48:27 +08:00
Overlays:
2011-01-12 17:43:36 +08:00
2011-03-02 00:48:27 +08:00
- GeoJSON, KML, GeoRSS layers
2011-03-01 23:41:33 +08:00
- mouse events in polylines, polygons and circles
2011-01-12 17:43:36 +08:00
2011-03-02 00:48:27 +08:00
Interaction:
2010-09-25 22:25:41 +08:00
2010-09-29 02:12:19 +08:00
- double tap on mobile webkit
2010-09-29 02:13:22 +08:00
- panning intertia on mobile webkit
2010-09-23 23:44:14 +08:00
Controls:
2010-09-23 23:47:38 +08:00
2010-09-23 23:44:14 +08:00
- control infrastructure (smart positioning)
2011-03-02 00:48:27 +08:00
- basic zoom control, zoom slider
2010-09-23 23:44:14 +08:00
- copyright control
2011-01-12 17:43:36 +08:00
Known issues to be fixed:
2011-03-23 23:48:17 +08:00
- flickering of vector layers on drag end under mobile webkit
2011-03-28 20:51:05 +08:00
- show scaled background until tiles are loaded on mobile webkit
2011-01-20 23:38:10 +08:00
## Browser support
On desktop:
- Firefox 3.6+
- Chrome
- Safari 5
- IE 7-9
- IE 6 (not perfect but accessible)
2011-01-20 23:38:10 +08:00
On mobile:
- Safari for iOS 3/4+
- WebKit for Android 2.2+
2011-01-12 17:43:36 +08:00
## Leaflet developers
2011-03-28 20:51:05 +08:00
Maintainer: [Vladimir Agafonkin](http://github.com/mourner), CloudMade
Contributors: (be the first!)