Changed readme information

This commit is contained in:
Jake Howard 2015-09-28 21:05:31 +01:00
parent 1c6cefcfba
commit dd83e3143a
3 changed files with 12 additions and 20 deletions

3
.gitignore vendored
View file

@ -58,4 +58,5 @@ target/
# Other
MANIFEST
MANIFEST
README.rst

18
README
View file

@ -1,18 +0,0 @@
Printr
======
Printr is a simple PyPi module that allows for print statements to be
replaces with a new line. Particularly useful for displaying progress
messages.
Installation
------------
Installation can be done using pip in the standard way;
::
pip install python-printr
If you have python 3 installed, then install using ``pip3``. There are
no dependancies for this package, so installation should go ahead fine.

View file

@ -4,10 +4,19 @@ Printr is a simple PyPi module that allows for print statements to be replaces w
## Installation
Installation can be done using pip in the standard way;
Installation can be done using pip in the standard way:
```
pip install python-printr
```
If you have python 3 installed, then install using `pip3`. There are no dependancies for this package, so installation should go ahead fine.
Alternatively, you can download directly from Pypi [here](https://pypi.python.org/pypi/Python-Printr/).
## Usage
```
import printr
printr.get_version()
>>> 0.0.1
```
The printr module contains various different printrs to assist you. You can find more information about these printrs on the wiki.