Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
RLovelett committed Nov 4, 2012
1 parent 7ecb1c7 commit 7f8dba8
Showing 1 changed file with 36 additions and 7 deletions.
43 changes: 36 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,33 @@
# SportsDataApi
# SportsDataApi [![Build
Status](https://travis-ci.org/RLovelett/sports_data_api.png)](https://travis-ci.org/RLovelett/sports_data_api)

TODO: http://developer.sportsdatallc.com/docs/NFL_API
SportsDataApi is an attempt to make a Ruby interface to the
[SportsData](http://www.sportsdatallc.com/) API. The goal is to
eventaully support the full API. Pull requests that extend the API
support are always welcome.

[SportsData](http://www.sportsdatallc.com/)’s comprehensive data coverage includes all major U.S. sports,
plus hundreds of leagues throughout the world. Their live game analysts
capture every possible event of every game, in real time and with
accuracy standards developed from years of experience.

## Author

[Ryan Lovelett](http://ryan.lovelett.me/) ( [@rlovelett](http://twitter.com/#!/rlovelett) )

Drop me a message for any questions, suggestions, requests, bugs or
submit them to the [issue
log](https://github.com/rlovelett/sports_data_api/issues).

## API Support

* [NFL](http://developer.sportsdatallc.com/docs/NFL_API)
* TODO
1. [MLB](http://developer.sportsdatallc.com/docs/MLB_API)
2. [NHL](http://developer.sportsdatallc.com/docs/NHL_API)
3. [NBA](http://developer.sportsdatallc.com/docs/NBA_API)
4. [NCAA Basketball](http://developer.sportsdatallc.com/docs/NCAA_Mens_Backetball)
5. [NCAA Football](http://developer.sportsdatallc.com/docs/NCAA_Football_API)

## Installation

Expand All @@ -18,12 +45,14 @@ Or install it yourself as:

## Usage

TODO: Write usage instructions here
The specs for this Gem should give you some idea of how to make use of
the API. For now they will be the usage information. As always Pull
Requests for better documentation are always welcome.

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
2. Create a topic branch (`git checkout -b topic`)
3. Make your changes
4. Squash your changes into one commit
5. Create new Pull Request against this squashed commit

0 comments on commit 7f8dba8

Please sign in to comment.