Leaflet/README.md

21 lines
1.8 KiB
Markdown
Raw Normal View History

2012-10-26 22:58:20 +08:00
<img src="http://leafletjs.com/docs/images/logo.png" alt="Leaflet" />
2011-05-19 20:55:53 +08:00
2012-10-31 22:33:58 +08:00
**Leaflet** is a modern open-source JavaScript library for **mobile-friendly interactive maps**. It is developed by [Vladimir Agafonkin][] of [CloudMade][] with a team of dedicated [contributors][]. Weighing just about <abbr title="That's 102 KB minified and 176 KB in the source form, with 8 KB of CSS (1.8 KB gzipped) and 10 KB of images">27 KB of gzipped JS code</abbr>, it has all the [features][] most devepers ever need for online maps.
2010-09-23 16:57:14 +08:00
2012-10-31 22:33:58 +08:00
Leaflet is designed with *simplicity*, *performance* and *usability* in mind. It works efficiently across all major desktop and mobile platforms out of the box, taking advantage of HTML5 and CSS3 on modern browsers while being accessible on older ones too. It can also be extended with many [plugins][], has a beautiful, easy to use and [well-documented][] API and a simple, readable [source code][] that is a joy to [contribute][] to.
2010-09-23 16:57:14 +08:00
2012-10-31 22:33:58 +08:00
For more information, check out the [official website][].
2011-01-12 17:43:36 +08:00
2012-10-31 22:33:58 +08:00
We're happy to meet new contributors. If you want to **get involved with Leaflet development**, check out the [contribution guide][contribute]. Let's make the best open-source library for maps that can possibly exist!
2011-12-13 03:48:20 +08:00
2012-10-31 22:33:58 +08:00
[Vladimir Agafonkin]: http://agafonkin.com/en
[CloudMade]: http://cloudmade.com
[contributors]: https://github.com/CloudMade/Leaflet/graphs/contributors
[features]: http://leafletjs.com/features.html
[plugins]: plugins.html
[well-documented]: reference.html "Leaflet API reference"
[source code]: https://github.com/CloudMade/Leaflet "Leaflet GitHub repository"
[hosted on GitHub]: http://github.com/CloudMade/Leaflet
[contribute]: https://github.com/CloudMade/Leaflet/blob/master/CONTRIBUTING.md "A guide to contributing to Leaflet"
[official website]: http://leafletjs.com