Permalink
Browse files

documentation tweak

  • Loading branch information...
1 parent c27f93d commit 617738b4c57951e4ef5af1f03be033a79765039f @joshavant committed Apr 14, 2012
Showing with 3 additions and 1 deletion.
  1. +3 −1 README.md
View
@@ -13,13 +13,15 @@
```ruby
require 'geopoint_factory'
-generator = GeoPointFactory::Generator.new("path/to/shapefile")
+generator = GeoPointFactory::Generator.new("path/to/shapefile") # omit file extension
point_inside = generator.generate
different_point_inside = generator.generate
yet_another_point_inside = generator.generate
generator.finalize
```
+* When done with a Generator instance, call #finalize.
+
## Discussion
GeoPoint Factory was developed as a way to easily generate geographic coordinate data within a specific geographic area, while avoiding areas that may not be useful, such as in the ocean.

0 comments on commit 617738b

Please sign in to comment.