documentation and licence

Author: coderhs

LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 HsPS <[email protected]>, Deepak Kumar<[email protected]>
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README

@@ -0,0 +1,45 @@
+## A ruby wrapper for Open Weather Map API.
+
+## Installation
+
+Add the following to your **Gemfile**
+
+    gem 'open_weather'
+
+  or
+
+    $ gem install open_weather
+
+## Usage
+
+    require 'open_weather'
+
+    # current weather APIs
+
+    # get current weather by city name
+    OpenWeather::Current.city("Cochin, IN")
+
+    # get current weather by city id
+    OpenWeather::Current.city_id("1273874")
+
+    # get current weather by geocode. (lat, lon)
+    OpenWeather::Current.geocode(9.94, 76.26)
+
+    # weather forecast APIs
+
+    # get weather forecast by city name
+    OpenWeather::Forecast.city("Cochin, IN")
+
+    # get weather forecast by city id
+    OpenWeather::Forecast.city_id("1273874")
+
+    # get weather forecast by geocode. (lat, lon)
+    OpenWeather::Forecast.geocode(9.94, 76.26)
+ 
+## Contributing 
+
+  Fork it
+  Create your feature branch (git checkout -b my-new-feature)
+  Commit your changes (git commit -am 'Added some feature')
+  Push to the branch (git push origin my-new-feature)
+  Create new Pull Request