From dd83e3143aa0c20a4e421df4ba19b4479be7c3ab Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Mon, 28 Sep 2015 21:05:31 +0100 Subject: [PATCH] Changed readme information --- .gitignore | 3 ++- README | 18 ------------------ README.md | 11 ++++++++++- 3 files changed, 12 insertions(+), 20 deletions(-) delete mode 100644 README diff --git a/.gitignore b/.gitignore index 6db6608..9ce7e8f 100644 --- a/.gitignore +++ b/.gitignore @@ -58,4 +58,5 @@ target/ # Other -MANIFEST \ No newline at end of file +MANIFEST +README.rst \ No newline at end of file diff --git a/README b/README deleted file mode 100644 index 2244dd6..0000000 --- a/README +++ /dev/null @@ -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. diff --git a/README.md b/README.md index fd9acc3..299924c 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file