README.md in geonames_api-0.1.1 vs README.md in geonames_api-0.1.2
- old
+ new
@@ -1,28 +1,18 @@
# GeoNames API
-[![Build Status](https://secure.travis-ci.org/mceachen/geonames_api.png?branch=master)](http://travis-ci.org/mceachen/geonames_api)
-[![Code Climate](https://codeclimate.com/github/mceachen/geonames_api.png)](https://codeclimate.com/github/mceachen/geonames_api)
+[![Build Status](https://secure.travis-ci.org/buytruckload/geonames_api.png?branch=master)](http://travis-ci.org/buytruckload/geonames_api)
+[![Code Climate](https://codeclimate.com/repos/52a4b4c513d63712180028d4/badges/33cf2af8b28c4cb66098/gpa.png)](https://codeclimate.com/repos/52a4b4c513d63712180028d4/feed)
This is a lightweight client for the [GeoNames](http://www.geonames.org) API. Huge thanks to them for such a great service!
There are many GeoNames API clients. BUT, most are rewritten versions of a Java API whose interface is a little funny =|
This is a simplified ruby implementation that does not implement the entire API. But, its lightweight and has a nice interface and will be easy to extend :)
## Getting Started
-Add this line to your application's Gemfile:
-
- gem 'geonames_api'
-
-And then execute:
-
- $ bundle
-
-Or install it yourself as:
-
$ gem install geonames_api
## Usage
### FYI
@@ -187,9 +177,11 @@
* properly encoded url parameters,
* support for paid users (with https and API tokens)
* more consistent ```find``` and ```where``` methods across endpoints
* Timezone, AlternateName, and GeoName entries properly encoded in results
* better test coverage, Travis CI, and CodeClimate integration
+
+To contribute:
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)