#1 #2: Improving doc and package

josuebrunel · Jun 29, 2015 · 121ffc1 · 121ffc1
1 parent 135afb0
commit 121ffc1
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -11,6 +11,9 @@
 
 ## Quickstart
 
+```python
+```
+
 ## How to contribute
 
 - Open an issue

diff --git a/README.rst b/README.rst
@@ -0,0 +1,37 @@
+Yahoo Fantasy Sport API
+=======================
+
+`|Build
+Status| <https://travis-ci.org/josuebrunel/yahoo-fantasy-sport>`_
+`|Coverage
+Status| <https://coveralls.io/r/josuebrunel/yahoo-fantasy-sport?branch=master>`_
+`|Code
+Health| <https://landscape.io/github/josuebrunel/yahoo-fantasy-sport/master>`_
+
+Authors
+-------
+
+-  `Josue Kouka <https://github.com/josuebrunel>`_
+-  `Paul Singman <https://github.com/unpairestgood>`_
+
+Quickstart
+----------
+
+::
+
+How to contribute
+-----------------
+
+-  Open an issue
+-  Fork the repository
+-  Make your changes
+-  Test your changes
+-  Add yourself to the AUTHORS.txt file
+-  Submit a pull request
+
+.. |Build
+Status| image:: https://travis-ci.org/josuebrunel/yahoo-fantasy-sport.svg?branch=master
+.. |Coverage
+Status| image:: https://coveralls.io/repos/josuebrunel/yahoo-fantasy-sport/badge.svg?branch=master
+.. |Code
+Health| image:: https://landscape.io/github/josuebrunel/yahoo-fantasy-sport/master/landscape.svg?style=flat