Skip to content

Commit

Permalink
Merge cf290a4 into 0d0a071
Browse files Browse the repository at this point in the history
  • Loading branch information
dnlkoch committed Mar 21, 2019
2 parents 0d0a071 + cf290a4 commit 275ffb1
Showing 1 changed file with 4 additions and 13 deletions.
17 changes: 4 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,15 @@
[![devDependencies Status](https://david-dm.org/terrestris/react-geo/dev-status.svg)](https://david-dm.org/terrestris/react-geo?type=dev)
[![dependencies Status](https://david-dm.org/terrestris/react-geo/status.svg)](https://david-dm.org/terrestris/react-geo)

A set of geo related modules. To use in combination with [react](https://github.com/facebook/react), [antd](https://github.com/ant-design/ant-design) and [ol](https://github.com/openlayers/openlayers).

* testing using jest on es6 modules, optionally with coverage
* webpack to produce optimized and debug builds
* documented using [React Styleguidist](https://react-styleguidist.js.org/)
* autogenerated examples from a template, including highlighted source code

## Feature List

You can find a complete [Feature List](https://github.com/terrestris/react-geo/wiki/Feature-List) in the wiki.
A set of geo related components to use in combination with [react](https://github.com/facebook/react), [antd](https://github.com/ant-design/ant-design) and [ol](https://github.com/openlayers/openlayers).

## Examples and API documentation

Visit https://terrestris.github.io/react-geo/
Visit [https://terrestris.github.io/react-geo/docs/latest/index.html](https://terrestris.github.io/react-geo/docs/latest/index.html)

## Workshop

Visit https://terrestris.github.io/react-geo-ws/
Visit [https://terrestris.github.io/react-geo-ws/](https://terrestris.github.io/react-geo-ws/)

## Installation

Expand All @@ -36,7 +27,7 @@ npm i @terrestris/react-geo
### Requirements

react-geo is designed to be used with es6-modules.
To use a component just import it like we do it in the [examples](https://terrestris.github.io/react-geo/examples/index.html):
To use a component just import it like we do it in the [examples](https://terrestris.github.io/react-geo/docs/latest/index.html):

```javascript static
import {
Expand Down

0 comments on commit 275ffb1

Please sign in to comment.