Leaflet/README.md

52 lines
1.5 KiB
Markdown
Raw Normal View History

2010-09-23 19:16:31 +08:00
Leaflet
=======
2010-09-23 17:04:30 +08:00
Leaflet is a lightweight JavaScript library for map display and interaction by [CloudMade](http://cloudmade.com). It will form the core of CloudMade's next generation JavaScript API.
2010-09-23 16:57:14 +08:00
2011-01-12 17:43:36 +08:00
It is built from the ground up to work well on both desktop and mobile web browsers, utilizing cutting-edge technologies included in HTML5. It focuses on performance, usability, [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
2010-11-16 22:04:56 +08:00
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-01-12 17:43:36 +08:00
Overlays:
- vectors (polyline, polygon, circle)
- KML, GeoRSS, GeoJSON layers
2010-09-25 22:25:41 +08:00
Interaction:
2010-09-23 23:44:14 +08:00
- shift-drag zoom
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)
- copyright control
- basic zoom control
- zoom slider
2011-01-12 17:43:36 +08:00
Known issues to be fixed:
2011-01-16 08:53:59 +08:00
- show scaled background until tiles are loaded even with animation disabled
2011-01-20 23:38:10 +08:00
## Browser support
On desktop:
- Firefox 3.6+
- Chrome
- Safari 5
- IE 9
- IE 6-8 (not perfect but fully 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
Lead Developer: [Vladimir Agafonkin](http://github.com/mourner)
2011-01-12 17:43:36 +08:00
Contributors: be the first!