README.md in on_the_map-0.1.3 vs README.md in on_the_map-0.1.4
- old
+ new
@@ -14,11 +14,11 @@
The code examples below use the concerned gem to include the concern modules into a class.
You can use a simple `include OnTheMap::XXXX` in its place or some other concern related API of your choice.
### Adressable
-* embeds an `address` on the model
+* embeds an `address` on the model using `adressable` polymorphic relationship
* adds delegate methods to all embedded address fields (setters/getters)
* adds `full_address` method that returns full adress from concatenation of all fields
Address fields: `city, state, state_code, province, province_code, postal_code, country, country_code`
@@ -26,34 +26,67 @@
class MyModel
include Mongoid::Document
include_concern :addressable, from: :on_the_map
end
+
+
+model = MyModel.new
+model.addressable = Address.new street: 'madison avenue 1'
+model.addressable.city == 'New York'
```
### GeoLocatable
* includes `addressable` and `positionable` concerns
* performs geocoding to calculate new position after an address is created or updated
* adds `latitude` and `longitude` to model
+*Usage*
+
+Gemfile
+
```ruby
+gem 'geocoder'
+```
+
+Depending on usage scenario, you might have to explicitly require *geocoder* also.
+
+`require 'geocoder'`
+
+Include the concern:
+
+```ruby
class MyModel
include Mongoid::Document
include_concerns :geo_locatable, from: 'OnTheMap'
end
```
### Mappable
-* include `Gmaps4rails::ActsAsGmappable`
+* includes `Gmaps4rails::ActsAsGmappable`
* adds field `normalized_address` to store full address calculated and returned by Google Maps geo-coding
* adds method `gmaps4rails_address` which returns adress used in gmaps geo-coding (if enabled)
* includes `geo_locatable` and `positionable` concerns.
+*Usage*
+
+Gemfile
+
```ruby
+gem 'gmaps4rails'
+```
+
+Depending on usage scenario, you might have to explicitly require *gmaps4rails* also.
+
+`require 'gmaps4rails'`
+
+Include the concern:
+
+```ruby
class MyModel
include Mongoid::Document
include_concerns :mappable, from: 'OnTheMap'
end
@@ -63,9 +96,25 @@
* includes `Mongoid::Geospatial` into the model to make GeoSpatial methods available
* Adds geo_field `position` (macro from Mongoid GeoSpatial)
* adds spatial indexing for position field
* positon field is indexed and used in geo-searches (fx find points near a point)
+
+*Usage*
+
+Gemfile
+
+```ruby
+gem 'mongoid_geospatial'
+```
+
+Depending on usage scenario, you might have to explicitly require *mongoid_geospatial* also.
+
+`require 'mongoid_geospatial'`
+
+Include the concern:
+
+
```ruby
class MyModel
include Mongoid::Document