Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
amosbastian committed Jan 29, 2019
1 parent c92436f commit 8c2ba7e
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 3 deletions.
2 changes: 1 addition & 1 deletion AUTHORS.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Maintainer
``````````

- Amos Bastian <[email protected]> `@amosbastian <https://github.com/kennethreitz>`_,
- Amos Bastian <[email protected]> `@amosbastian <https://github.com/amosbastian>`_,

Contributors
````````````
Expand Down
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,36 @@ The recommended way to install fpl is via ``pip``.

pip install fpl

To install it directly from GitHub you can do the following:

git clone git://github.com/amosbastian/fpl.git

You can also install a [.tar file](https://github.com/requests/requests/tarball/master)
or [.zip file](https://github.com/requests/requests/tarball/master)

$ curl -OL https://github.com/amosbastian/fpl/tarball/master
$ curl -OL https://github.com/amosbastian/fpl/zipball/master # Windows

Once it has been downloaded you can easily install it using `pip`::

$ cd fpl
$ pip install .

## Contributing

Proper contributing guidelines will be added soon.
1. Fork the repository on GitHub.
2. Run the tests with `pytest tests/` to confirm they all pass on your system.
If the tests fail, then try and find out why this is happening. If you aren't
able to do this yourself, then don't hesitate to either create an issue on
GitHub, contact me on Discord or send an email to [[email protected]](mailto:[email protected]>).
3. Either create your feature and then write tests for it, or do this the other
way around.
4. Run all tests again with with `pytest tests/` to confirm that everything
still passes, including your newly added test(s).
5. Create a pull request for the main repository's ``master`` branch.

For more information on how to contribute to **fpl** see [the contributing guide](https://fpl.readthedocs.io/en/latest/contributing/contributing.html).

## Documentation

Documentation and examples for `fpl` can be found at http://fpl.readthedocs.io/en/latest/.
Documentation and examples for **fpl** can be found at http://fpl.readthedocs.io/en/latest/.

0 comments on commit 8c2ba7e

Please sign in to comment.