README.md in terraformer-0.0.9 vs README.md in terraformer-0.1.0

- old
+ new

@@ -1,22 +1,30 @@ terraformer-ruby ================ -mostly faithful port of [terraformer](https://github.com/Esri/Terraformer) +[terraformer-ruby](https://github.com/kenichi/terraformer-ruby) is a mostly faithful port of [terraformer](https://github.com/Esri/Terraformer). -### Installation +## Installation -`gem install terraformer` +In your application's Gemfile: -or include in an application's `Gemfile` +```ruby +gem 'terraformer' +``` -`gem terraformer` +Or install it manually: -### Basic usage +```sh +$ gem install terraformer +``` -[terraformer-ruby](https://github.com/esripdx/terraformer-ruby) is a port of [terraformer](https://github.com/Esri/Terraformer). +## Usage +```ruby +require 'terraformer' +``` + ##### Create a Terraformer primitive from GeoJSON ``` > polygon = Terraformer.parse '{ "type": "Polygon", @@ -49,6 +57,23 @@ You can also have Terraformer perform many geometric operations like convex hulls and bounding boxes. ``` > convex_hull = polygon.convex_hull > point.within? convex_hull #returns true > bounding_box = polygon.bbox #returns the bounding box for this object. -``` \ No newline at end of file +``` + +## Contributing + +After checking out the source, run the tests: + +``` +$ git clone git@github.com:kenichi/terraformer-ruby.git +$ cd terraformer-ruby +$ bundle install +$ bundle exec rake test +``` + +You can also generate RDoc: + +``` +$ bundle exec rdoc --main README.md +```