Permalink
Browse files

Further cleanup and fixes

  • Loading branch information...
1 parent 3f534ef commit 385afdebfaa5dec41d1ce08cae987fedcdc6ccb7 @manveru committed Jun 5, 2010
Showing with 255 additions and 171 deletions.
  1. +29 −2 README.textile → README.md
  2. +226 −169 lib/geonames.rb
@@ -1,11 +1,38 @@
-h1. GeoNames API wrapper
+# GeoNames API wrapper
The GeoNames geographical database covers all countries and contains over eight
million placenames that are available for download free of charge.
http://www.geonames.org/
-h2. This library is licensed under the MIT License
+
+## Dependencies
+
+This library depends on addressable, you can install it with
+`gem install addressable`.
+
+
+## Usage
+
+Instantiate the API and make a query:
+
+ >> api = GeoNames.new
+ >> api.ocean(lat: 0, lng: 0)
+ => {"name"=>"North Atlantic Ocean"}
+
+Please read the documentation of the methods in the GeoNames class for more
+information about the available methods and their arguments.
+
+
+## About
+
+I wrote this library in hopes to improve upon the original geonames library
+written by Adam Wisniewski.
+It's around 1/5 of the code now, and should be easier to read, understand,
+extend, and hack while being closer to the original specification of the API.
+
+
+### This library is licensed under the MIT License
Copyright (c) 2010 Michael Fellinger
Oops, something went wrong.

0 comments on commit 385afde

Please sign in to comment.