37 lines
2.4 KiB
Markdown
37 lines
2.4 KiB
Markdown
# OpenLayers
|
|
|
|
[](http://travis-ci.org/#!/openlayers/openlayers)
|
|
[](https://greenkeeper.io/)
|
|
[](https://coveralls.io/github/openlayers/openlayers?branch=master)
|
|
[](http://osgeo.org/)
|
|
|
|
[OpenLayers](https://openlayers.org/) is a high-performance, feature-packed library for creating interactive maps on the web. It can display map tiles, vector data and markers loaded from any source on any web page. OpenLayers has been developed to further the use of geographic information of all kinds. It is completely free, Open Source JavaScript, released under the 2-clause BSD License (also known as the FreeBSD).
|
|
|
|
## Getting Started
|
|
|
|
- Download the [latest release](https://openlayers.org/download/)
|
|
- Install with npm: `npm install openlayers`
|
|
- Clone the repo: `git clone git@github.com:openlayers/openlayers.git`
|
|
|
|
## Supported Browsers
|
|
|
|
OpenLayers runs on all modern browsers that support [HTML5](https://html.spec.whatwg.org/multipage/) and [ECMAScript 5](http://www.ecma-international.org/ecma-262/5.1/). This includes Chrome, Firefox, Safari and Edge. For older browsers and platforms like Internet Explorer (down to version 9) and Android 4.x, [polyfills](http://polyfill.io) for `requestAnimationFrame` and `Element.prototype.classList` are required, and using the KML format requires a polyfill for `URL`.
|
|
|
|
## Documentation
|
|
|
|
Check out the [hosted examples](https://openlayers.org/en/latest/examples/), the [workshop](https://openlayers.org/workshop/) or the [API documentation](https://openlayers.org/en/latest/apidoc/).
|
|
|
|
## Bugs
|
|
|
|
Please use the [GitHub issue tracker](https://github.com/openlayers/openlayers/issues) for all bugs and feature requests. Before creating a new issue, do a quick search to see if the problem has been reported already.
|
|
|
|
## Contributing
|
|
|
|
Please see our guide on [contributing](CONTRIBUTING.md) if you're interested in getting involved.
|
|
|
|
## Community
|
|
|
|
- Need help? Find it on [Stack Overflow using the tag 'openlayers'](http://stackoverflow.com/questions/tagged/openlayers)
|
|
- Follow [@openlayers](https://twitter.com/openlayers) on Twitter
|
|
- Discuss with openlayers users on IRC in `#openlayers` at `chat.freenode`
|