Skip to content
This repository has been archived by the owner on Dec 15, 2020. It is now read-only.

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Jackevansevo committed Jun 13, 2017
1 parent fdb422e commit 3e2f6c1
Showing 1 changed file with 31 additions and 2 deletions.
33 changes: 31 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@ Useful utilities for Python 3.4+
Documentation
=============

See available utilities by reading the docs here: `<http://basic-utils.readthedocs.io/en/latest/?badge=latest>`_
See what's available by reading the docs here_

.. _here: http://basic-utils.readthedocs.io/en/latest/?badge=latest

Installation
=============
Expand All @@ -30,6 +32,33 @@ Install through PyPi with the following::

pip3 install basic-utils


FAQ
===

Q: Does anyone use this?

A: Not that I know of

Q: Should I use this?

A: Sure (but at your own risk)

Q: Why doesn't have X

A: Open an issue or Pull request


Similar Projects
================

- Toolz_
- UnderScoreJS_

.. _Toolz: https://github.com/pytoolz/toolz
.. _UnderScoreJS: https://github.com/jashkenas/underscore


Running Tests
=============

Expand All @@ -48,7 +77,7 @@ Activate the virtualenv
Install requirements

.. code-block:: bash
pip install -e ."[test]"
Install requirements and run:
Expand Down

0 comments on commit 3e2f6c1

Please sign in to comment.