Add directions + package description to usage/index docs

This commit is contained in:
Cameron Yick
2017-08-27 00:26:58 -04:00
parent 89029b6af8
commit d490fd3841
4 changed files with 70 additions and 6 deletions

View File

@@ -15,7 +15,7 @@ Types of Contributions
Report Bugs
~~~~~~~~~~~
Report bugs at https://github.com/hydrosquall/tiingo/issues.
Report bugs at https://github.com/hydrosquall/tiingo-python/issues.
If you are reporting a bug, please include:
@@ -45,7 +45,7 @@ articles, and such.
Submit Feedback
~~~~~~~~~~~~~~~
The best way to send feedback is to file an issue at https://github.com/hydrosquall/tiingo/issues.
The best way to send feedback is to file an issue at https://github.com/hydrosquall/tiingo-python/issues.
If you are proposing a feature:
@@ -62,12 +62,12 @@ Ready to contribute? Here's how to set up `tiingo` for local development.
1. Fork the `tiingo` repo on GitHub.
2. Clone your fork locally::
$ git clone git@github.com:your_name_here/tiingo.git
$ git clone git@github.com:your_name_here/tiingo-python.git
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
$ mkvirtualenv tiingo
$ cd tiingo/
$ mkvirtualenv tiingo-python
$ cd tiingo-python/
$ python setup.py develop
4. Create a branch for local development::
@@ -102,7 +102,7 @@ Before you submit a pull request, check that it meets these guidelines:
your new functionality into a function with a docstring, and add the
feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check
https://travis-ci.org/hydrosquall/tiingo/pull_requests
https://travis-ci.org/hydrosquall/tiingo-python/pull_requests
and make sure that the tests pass for all supported Python versions.
Tips