README.md in geojson2image-0.1.4 vs README.md in geojson2image-0.2.0

- old
+ new

@@ -2,17 +2,15 @@ [![Gem Version](http://img.shields.io/gem/v/geojson2image.svg)][gem] [gem]: https://rubygems.org/gems/geojson2image -Ruby library for generating images from GeoJSON. +Ruby library for generating images from GeoJSON using the [ChunkyPNG library](https://github.com/wvanbergen/chunky_png). -Currently, MultiPolygon and Polygon GeoJSON types should output images properly. Other GeoJSON types have not been thoroughly tested. - ## Installation -You will need [ImageMagick](http://imagemagick.org/) installed. Then Add this line to your application's Gemfile: +Add this line to your application's Gemfile: ```ruby gem 'geojson2image' ``` @@ -32,14 +30,13 @@ g2i = Geojson2image::Convert.new( json: gjson, width: 500, height: 500, padding: 50, - background_color: 'white', - fill_color: 'rgba(0, 158, 40, 0.3)', - stroke_color: 'rgb(0, 107, 27)', - stroke_width: 3, + background_color: "#ffffff", + fill_color: "#008000", + stroke_color: "#006400", output: "output.jpg" ) g2i.to_image ``` @@ -47,23 +44,21 @@ ![Example Output](example/example_output.jpg?raw=true "Example Output") ### Stroke and Fill Color Options -Valid color values are defined in the ImageMagick Color Names Reference: -https://www.imagemagick.org/script/color.php +Accepts hex color format Stroke and fill color options can be globally set when initializing a new Geojson2image::Convert object, or you can override them by adding properties to your GeoJSON that include the desired stroke and fill options per feature. Example: ```json "properties": { - "fill_color": "rgba(0, 158, 40, 0.3)", - "stroke_color": "rgb(0, 107, 27)", - "stoke_width": "3", + "fill_color": "#008000", + "stroke_color": "#006400" }, ``` **Example Output** ![Example Output](example/fill_options_example.jpg?raw=true "Fill Options Example Output") @@ -74,10 +69,10 @@ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/CropQuest/geojson2image. +Bug reports and pull requests are welcome on GitHub at https://github.com/beaorn/geojson2image. ## License The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).