From 59ba663ebee17063b5356da980d1cdf3bdadefa8 Mon Sep 17 00:00:00 2001 From: hellerve Date: Sat, 11 Jul 2015 23:16:27 +0200 Subject: [PATCH] Updated readme with installation instructions and usage --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index e1e8625..a13c9d3 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,28 @@ that is fully documented, occassionally improved and embeddable into Python. As you may notice, I am bad at documentation. + +###Installation + +The package has a setuptools toolchain, but is not (yet?) on pip, +which means that installation has to be performed manually. The +process looks like this: + +```sh +git clone https://github.com/hellerve/IMProved +cd IMProved +python setup.py install +``` + +And you're good to go! + +###Usage + +Easy! + +````python +import improved + +improved.callIMP("n := 5") +# this will return a dictionary containing the key/value pair n/5 +```