README.md in wwo-0.1.1 vs README.md in wwo-0.1.2

- old
+ new

@@ -1,14 +1,22 @@ # WWO - World Weather Online API Gem +[![Gem Version](https://badge.fury.io/rb/wwo.svg)](https://badge.fury.io/rb/wwo) [![Build Status](https://travis-ci.org/sujrd/wwo.svg?branch=master)](https://travis-ci.org/sujrd/wwo) [![Join the chat at https://gitter.im/sujrd/wwo](https://badges.gitter.im/sujrd/wwo.svg)](https://gitter.im/sujrd/wwo?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Code Climate](https://codeclimate.com/github/sujrd/wwo/badges/gpa.svg)](https://codeclimate.com/github/sujrd/wwo) [![Test Coverage](https://codeclimate.com/github/sujrd/wwo/badges/coverage.svg)](https://codeclimate.com/github/sujrd/wwo/coverage) [![License](http://img.shields.io/:license-mit-blue.svg)](http://sujrd.mit-license.org) + This gem provides a (for now) very opinionated interface to [World Weather Online's API][1]. It's based heavily on the [forecast-ruby gem](https://github.com/darkskyapp/forecast-ruby) by the wonderful people over at Dark Skies / Forecast.io and was bourne out of the need to have a drop in replacemnet for Forecast.io in an application. -The plan is to ehance this over time so that it supports more of WWO's API. Right now it supports forecasts and historical -weather for a lat / long pair of anywhere in the world. +The plan is to enhance this over time so that it supports more of WWO's API and is a bit more developer friendly. Right now, +however, there are the following assumptions / options that you need to be aware of: + * Temperatures are always returned in **degrees celcius**. + * For now we only expect requests for one day at a time, as per the way forecast-ruby works + * We only pull in **daily snapshot** information, that is, the predomanant weather over the 24h period of the day in question. + * We futz around with the response back, so it is in the same shape of JSON as you get back from `forecast.io`. This is intentional - + remember that we intend this to be (for now), a drop-in replacement for forecast.io. + ## Installation Add this line to your application's Gemfile: ```ruby @@ -65,6 +73,6 @@ ## License The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). -[1]: https://developer.worldweatheronline.com \ No newline at end of file +[1]: https://developer.worldweatheronline.com