README.md in owmo-1.0.1 vs README.md in owmo-1.1.0

- old
+ new

@@ -22,95 +22,93 @@ ## Usage You'll need and API key from [OpenWeatherMap.org](http://openweathermap.org/appid). -Compelete examples can be found under owmo/examples. +Complete examples can be found under owmo/examples. ---- ### Quick Start ```ruby require 'owmo' api_key = "<api key here>" -weather = OWMO::Weather.new api_key +weather = OWMO::weather api_key puts weather.get :current, city_name: "London,UK" ``` ```ruby require 'owmo' api_key = "<api key here>" -OWMO::weather api_key do |weather| - puts weather.get :forecast, city_name: "London,UK" -end +OWMO::weather(api_key) { |weather| puts weather.get :current, city_name: "London,UK" } ``` ---- ### Weather Information #### [Current weather data](http://openweathermap.org/current) ```ruby -puts weather.get :current, city_name: "London,UK" +weather.get :current, city_name: "London,UK" ``` [Full example](https://github.com/robb-randall/owmo/blob/master/examples/current.rb) #### [5 day weather forecast](http://openweathermap.org/forecast5) ```ruby -puts weather.get :forecast5, city_name: "London,UK" +weather.get :forecast5, city_name: "London,UK" ``` [Full example](https://github.com/robb-randall/owmo/blob/master/examples/forecast5.rb) #### [16 day weather forecast](http://openweathermap.org/forecast16) ```ruby -puts weather.get :forecast16, city_name: "London,UK" +weather.get :forecast16, city_name: "London,UK" ``` [Full example](https://github.com/robb-randall/owmo/blob/master/examples/forecast16.rb) ---- ### Query parameters #### Geocode (required) ```ruby # Geocode by City ID -puts weather.get :current, city_id: 5328041 -puts weather.get :current, id: 5328041 +weather.get :current, city_id: 5328041 +weather.get :current, id: 5328041 # Geocode by City Name -puts weather.get :current, city_name: "Beverly Hills" -puts weather.get :current, q: "Beverly Hills" +weather.get :current, city_name: "Beverly Hills" +weather.get :current, q: "Beverly Hills" # Geocode by Zip Code -puts weather.get :current, zip: 90210 -puts weather.get :current, zip_code: 90210 +weather.get :current, zip: 90210 +weather.get :current, zip_code: 90210 # Geocode by Coordinance -puts weather.get :current, lon: -118.41, lat: 34.09 +weather.get :current, lon: -118.41, lat: 34.09 ``` [Full example](https://github.com/robb-randall/owmo/blob/master/examples/query_geocode.rb) #### Mode ```ruby # Response in JSON format (default) -puts weather.get :current, city_name: "London,UK" -puts weather.get :current, city_name: "London,UK", mode: :json +weather.get :current, city_name: "London,UK" +weather.get :current, city_name: "London,UK", mode: :json # Response in XML format -puts weather.get :current, city_name: "London,UK", mode: :xml +weather.get :current, city_name: "London,UK", mode: :xml # Response in HTML format -puts weather.get :current, city_name: "London,UK", mode: :html +weather.get :current, city_name: "London,UK", mode: :html ``` [Full example](https://github.com/robb-randall/owmo/blob/master/examples/query_mode.rb) #### Units ```ruby # Kelvin (default) -puts weather.get :current, city_name: "London,UK" +weather.get :current, city_name: "London,UK" # Imperial -puts weather.get :current, city_name: "London,UK", units: :imperial +weather.get :current, city_name: "London,UK", units: :imperial # Metric -puts weather.get :current, city_name: "London,UK", units: :metric +weather.get :current, city_name: "London,UK", units: :metric ``` [Full example](https://github.com/robb-randall/owmo/blob/master/examples/query_units.rb) #### All ```ruby @@ -119,16 +117,16 @@ mode: 'json', units: 'imperial', lang: 'fr' } -puts weather.get :current, query +weather.get :current, query ``` [Full example](https://github.com/robb-randall/owmo/blob/master/examples/query_all.rb) ---- -### Wroking example using Sinatra +### Working example using Sinatra ```ruby require 'owmo' require 'sinatra' # Need to install, not included in gemspec require 'uri' @@ -151,12 +149,11 @@ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/owmo. +Bug reports and pull requests are welcome on GitHub at https://github.com/robb-randall/owmo. ## License The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). -