Sha256: ec2eefed4fcf177c82c91dab10440219f7b1204a129fdb94adeb4ce58b90acc8

Contents?: true

Size: 1.61 KB

Versions: 2

Compression:

Stored size: 1.61 KB

Contents

# darksky

Ruby gem for retrieving data from the [Dark Sky API](http://darkskyapp.com/api/). The Dark Sky API lets you query 
for short-term precipitation forecast data at geographical points inside the United States. 

## Installation

`gem install darksky`

or in your `Gemfile`

```ruby
gem 'darksky'
```
  
## Usage

```ruby
darksky = Darksky::API.new('this-is-your-dark-sky-api-key')

# Returns a forecast for the next hour at a given location.
forecast = darksky.forecast('42.7243','-73.6927')

# Returns a brief forecast for the next hour at a given location.
brief_forecast = darksky.brief_forecast('42.7243','-73.6927')

# Returns forecasts for a collection of arbitrary points.
precipitation = darksky.precipitation(['42.7','-73.6',1325607100,'42.0','-73.0',1325607791])

# Returns a list of interesting storms happening right now.
interesting_storms = darksky.interesting
```

## Contributing to darksky
 
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
* Fork the project
* Start a feature/bugfix branch
* Commit and push until you are happy with your contribution
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

## Copyright

Copyright (c) 2012 David Czarnecki. See LICENSE.txt for further details.

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
darksky-1.0.5 README.markdown
darksky-1.0.4 README.markdown