From d4ddb60e8bd21b823ccdd30d2726b994bbc6a1e3 Mon Sep 17 00:00:00 2001 From: Victor Malaret Date: Thu, 2 Apr 2015 13:29:09 +0200 Subject: [PATCH] Update README Adds basic quickstart, usage, issues, and community info to readme --- README.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 851a3bd48c..0f30481ad7 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,28 @@ [![Travis CI Status](https://secure.travis-ci.org/openlayers/ol3.svg)](http://travis-ci.org/#!/openlayers/ol3) [![Coverage Status](https://coveralls.io/repos/openlayers/ol3/badge.svg?branch=master)](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`