update README and add History.txt

brynary · May 29, 2009 · 4fcd1f5 · 4fcd1f5
1 parent ee1e9c1
commit 4fcd1f5
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 1 deletion.
diff --git a/History.txt b/History.txt
@@ -0,0 +1,3 @@
+=== 0.1.0 / 2009-05-29
+
+* 1st release
diff --git a/README b/README
@@ -25,7 +25,28 @@ geokit-rails
 Example
 =======
 
-Example goes here. Coming soon.
+Setup
 
+Say for your Rails app you're building a map of all the best burger joints in your area. To make your burger joints map ready:
+
+1. Use geokit/geokit-rails to provide geolocations (lat, lng) and add 'acts_as_mappable' to the class definition.
+2. Include 'MapMarker'
+
+class BurgerJoint < ActiveRecord::Base
+  acts_as_mappable
+  include MapMarker
+end
+
+Simple
+
+markers = MapReady::SimpleMarkerBuilder.new(burger_joints).create_markers
+
+Clustered
+
+markers = MapReady::ClusteredMarkerBuilder.new(burger_joints).create_markers
+
+Offset
+
+markers = MapReady::OffsetMarkerBuilder.new(burger_joints).create_markers
 
 Copyright (c) 2009 Ross Kaffenberger, released under the MIT license