README.md in rgeo-2.2.0 vs README.md in rgeo-2.3.0

- old
+ new

@@ -1,9 +1,9 @@ ## RGeo [![Gem Version](https://badge.fury.io/rb/rgeo.svg)](http://badge.fury.io/rb/rgeo) -[![Build Status](https://travis-ci.org/rgeo/rgeo.svg?branch=master)](https://travis-ci.org/rgeo/rgeo) +[![CI](https://github.com/rgeo/rgeo/workflows/CI/badge.svg)](https://github.com/rgeo/rgeo/actions?query=workflow%3ACI+branch%3Amaster+event%3Apush) RGeo is a geospatial data library for Ruby. :warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning: @@ -65,11 +65,11 @@ ```ruby gem "rgeo" ``` -If you are using proj.4 extensions, include +If you are using proj.4 extensions, include [`rgeo-proj4`](https://github.com/rgeo/rgeo-proj4): ```ruby gem "rgeo-proj4" ``` @@ -106,28 +106,44 @@ ### Development and support RDoc Documentation is available at https://www.rubydoc.info/gems/rgeo -Contributions are welcome. Please read the +Contributions are welcome. Please read the [Contributing guidelines](https://github.com/rgeo/rgeo/blob/master/CONTRIBUTING.md). -Support may be available on the +Support may be available on the [rgeo-users google group](https://groups.google.com/forum/#!forum/rgeo-users) or on [Stack Overflow](https://stackoverflow.com/questions/tagged/rgeo). +### Documentation -### Acknowledgments +You can see more in-depth documentation in the `doc` folder. Factories and +methods are documented inline, you should consider checking +https://rubydoc.info/gems/rgeo with the version you are currently using. Or +generate documentation locally if you're working on RGeo: `yardoc server`. -RGeo was created by [Daniel Azuma](http://www.daniel-azuma.com). -[Tee Parham](https://github.com/teeparham) is the current maintainer. +Here's the current list of available topics: -Thanks to [Pirq](http://www.pirq.com) and [Neighborland](https://neighborland.com) -for development support. +- [An introduction to Spatial Programming With RGeo](https://github.com/rgeo/rgeo/blob/master/doc/An-Introduction-to-Spatial-Programming-With-RGeo.md) +- [Enable GEOS and Proj4 on Heroku](https://github.com/rgeo/rgeo/blob/master/doc/Enable-GEOS-and-Proj4-on-Heroku.md) +- [Installing GEOS](https://github.com/rgeo/rgeo/blob/master/doc/Installing-GEOS.md) +- [Factory Compatibility](https://github.com/rgeo/rgeo/blob/master/doc/Factory-Compatibility.md) +- [Which factory should I use?](https://github.com/rgeo/rgeo/blob/master/doc/Which-factory-should-I-use.md) +- [Examples](https://github.com/rgeo/rgeo/blob/master/doc/Examples.md) +- [Who uses `rgeo`?](https://github.com/rgeo/rgeo/blob/master/doc/Gallery.md) -Thanks to [Travis-CI](https://travis-ci.org) for CI testing. +You can see an exhaustive and up to date list at https://rubydoc.info/gems/rgeo/index. +### Acknowledgments -Thanks to [JetBrains](https://www.jetbrains.com/?from=rgeo) for RubyMine license. +[Daniel Azuma](http://www.daniel-azuma.com) created RGeo. +[Tee Parham](http://twitter.com/teeparham) is a former maintainer. +[Keith Doggett](http://www.github.com/keithdoggett), [Ulysse Buonomo](http://www.github.com/BuonOmo) are current maintainers. + +Development is supported by: + +- [Klaxit](https://www.github.com/klaxit) +- Goldfish Ads RGeo calls the GEOS library to handle most Cartesian geometric calculations, and the Proj4 library to handle projections and coordinate transformations. These libraries are maintained by the Open Source Geospatial Foundation; more information is available on [OSGeo's web site](http://www.osgeo.org).