Skip to content
This repository has been archived by the owner on Jan 6, 2024. It is now read-only.

Commit

Permalink
#2 : updating docs ...
Browse files Browse the repository at this point in the history
  • Loading branch information
josuebrunel committed Jun 29, 2015
1 parent 0d453c4 commit 102a16a
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,5 @@
- Fork the repository
- Make your changes
- Test your changes
- Add yourself to the AUTHORS.txt file
- Add yourself into the AUTHORS.txt file
- Submit a pull request
34 changes: 34 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Yahoo Fantasy Sport API

[![Build Status](https://travis-ci.org/josuebrunel/yahoo-fantasy-sport.svg?branch=master)](https://travis-ci.org/josuebrunel/yahoo-fantasy-sport)
[![Coverage Status](https://coveralls.io/repos/josuebrunel/yahoo-fantasy-sport/badge.svg?branch=master)](https://coveralls.io/r/josuebrunel/yahoo-fantasy-sport?branch=master)
[![Code Health](https://landscape.io/github/josuebrunel/yahoo-fantasy-sport/master/landscape.svg?style=flat)](https://landscape.io/github/josuebrunel/yahoo-fantasy-sport/master)

## Authors

* [Josue Kouka](https://github.com/josuebrunel)
* [Paul Singman](https://github.com/unpairestgood)

## Quickstart

```python
>>> from yahoo_oauth import OAuth1
>>> oauth = OAuth1(None, None, from_file='oauth.json')
>>> from fantasy_sport import FantasySport
>>> yfs = FantasySport(oauth, fmt='json')
```

### Games Resources

### Leagues Resources

### Players Resources

## How to contribute

- Open an issue
- Fork the repository
- Make your changes
- Test your changes
- Add yourself into the AUTHORS.txt file
- Submit a pull request
11 changes: 11 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
site_name: Yahoo Fantasy Sport
repo_url: https://github.com/josuebrunel/yahoo-fantasy-sport
site_url: http://yahoo-fantasy-sport.readthedocs.org/en/latest/
site_description: Yahoo Fantasy Sport Python Wrapper
site_author: Josue Kouka
pages:
- Home : index.md
- Team : team.md
- League : league.md
- Player : player.md
theme: readthedocs

0 comments on commit 102a16a

Please sign in to comment.