Skip to content

Commit

Permalink
Add caveat to readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
airblade committed Feb 21, 2012
1 parent f7510b8 commit fe0c40e
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.md
@@ -1,13 +1,8 @@
# GeoTools

You have lots of plugin choices if you want to geocode North American addresses, or find all the locations near somewhere. But few help you with forms and validation.
## Caveat

This plugin does four things:

* Adds `latitude_field` and `longitude_field` form helpers to Rails' default form builder.
* Lets your model acts_as_location, to work seamlessly with the form helpers.
* Validates the location data entered on the form and in the database.
* Gives you a `within` named scope to find all lcoations within a given bounding box, such as you would have on a Google map.
This code is quite old. I wouldn't do things this way now, but it's in production and it works.


## Compatibility
Expand All @@ -17,6 +12,18 @@ Works on Ruby 1.8+ and 1.9+.
Designed for Rails 2.3.


## Overview

You have lots of plugin choices if you want to geocode North American addresses, or find all the locations near somewhere. But few help you with forms and validation.

This plugin does four things:

* Adds `latitude_field` and `longitude_field` form helpers to Rails' default form builder.
* Lets your model acts_as_location, to work seamlessly with the form helpers.
* Validates the location data entered on the form and in the database.
* Gives you a `within` named scope to find all lcoations within a given bounding box, such as you would have on a Google map.


## Assumptions

* Any model that acts_as_location has integers defined for each component of the latitude and longitude:
Expand Down

0 comments on commit fe0c40e

Please sign in to comment.