From 5fd28fe23487256d03ae3aacb7d0ebbc33f7ffe7 Mon Sep 17 00:00:00 2001
From: Alex Reisner <alex@alexreisner.com>
Date: Thu, 16 Apr 2009 00:33:45 -0400
Subject: [PATCH] Add basic documentation to README file.
---
README | 13 -------------
README.rdoc | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 55 insertions(+), 13 deletions(-)
delete mode 100644 README
create mode 100644 README.rdoc
diff --git a/README b/README
deleted file mode 100644
index 53cc8b44..00000000
--- a/README
+++ /dev/null
@@ -1,13 +0,0 @@
-Geocoder
-========
-
-Introduction goes here.
-
-
-Example
-=======
-
-Example goes here.
-
-
-Copyright (c) 2009 [name of plugin creator], released under the MIT license
diff --git a/README.rdoc b/README.rdoc
new file mode 100644
index 00000000..b3bd5e18
--- /dev/null
+++ b/README.rdoc
@@ -0,0 +1,55 @@
+= Geocoder
+
+Geocoder is a simple plugin for Rails that provides object geocoding (via
+Google Maps) and some utilities for working with geocoded objects. The code can
+be used as a standalone method provider or included in a class to give objects
+geographic awareness.
+
+== Setup
+
+Use the Rails plugin install script:
+
+ script/plugin install git://github.com/alexreisner/geocoder.git
+
+To add geocoding features to a class:
+
+ include Geocoder
+
+Be sure your class defines read/write attributes +latitude+ and +longitude+ as
+well as a method called +location+ that returns a string suitable for passing
+to a Google Maps search, for example:
+
+ New York City
+ 714 Green St, Big Town, MO
+ Dusseldorf, DE
+
+If your model has +address+, +city+, +state+, and +country+ attributes your
++location+ method might look something like this:
+
+ def location
+ [address, city, state, country].compact.join(', ')
+ end
+
+
+== Examples
+
+Look up coordinates of an object:
+
+ obj.fetch_coordinates # returns an array [lat, lon]
+ obj.fetch_and_assign_coordinates # writes values to +latitude+ and +longitude+
+
+Find distance between object and a point:
+
+ obj.distance_to(40.71432, -100.23487) # in miles
+ obj.distance_to(40.71432, -100.23487, :km) # in kilometers
+
+If you're using a MySQL database and you need to do a search for objects
+within a given distance from a point, this method will generate a query for you:
+
+ Geocoder.nearby_mysql_query('cities', 40.71432, -100.23487, 50)
+
+
+Please see the code for more methods and detailed information about arguments.
+
+
+Copyright (c) 2009 Alex Reisner, released under the MIT license
--
GitLab