Update README
Adds basic quickstart, usage, issues, and community info to readme
This commit is contained in:
24
README.md
24
README.md
@@ -3,10 +3,28 @@
|
||||
[](http://travis-ci.org/#!/openlayers/ol3)
|
||||
[](https://coveralls.io/r/openlayers/ol3?branch=master)
|
||||
|
||||
Welcome to [OpenLayers 3](http://openlayers.org/)!
|
||||
[OpenLayers 3](http://openlayers.org/) is a high-performance, feature-packed library for creating interactive maps on the web.
|
||||
|
||||
## Examples
|
||||
Check out the [hosted examples](http://openlayers.org/en/master/examples/), the [workshop](http://openlayers.org/ol3-workshop/) or poke around the evolving [API docs](http://openlayers.org/en/master/apidoc/).
|
||||
## Getting Started
|
||||
|
||||
- Download the [latest release](https://github.com/openlayers/ol3/releases/tag/v3.4.0)
|
||||
- Install with npm: `npm install openlayers`
|
||||
- Clone the repo: `git clone git@github.com:openlayers/ol3.git`
|
||||
|
||||
## Documentation
|
||||
|
||||
Check out the [hosted examples](http://openlayers.org/en/master/examples/), the [workshop](http://openlayers.org/ol3-workshop/) or [API docs](http://openlayers.org/en/master/apidoc/).
|
||||
|
||||
## Bugs
|
||||
|
||||
Please use the [GitHub issue tracker](https://github.com/openlayers/ol3/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 [stackoverflow using the tag 'openlayers-3'](http://stackoverflow.com/questions/tagged/openlayers-3)
|
||||
- Follow [@openlayers](https://twitter.com/openlayers) on Twitter
|
||||
- Discuss with openlayers users on IRC in `#openlayers` at `chat.freenode`
|
||||
|
||||
Reference in New Issue
Block a user