From 37163b750e371a8dffb6ef2c64d8d1a3a019495c Mon Sep 17 00:00:00 2001 From: Caner Candan <candan@info.univ-angers.fr> Date: Tue, 14 Jan 2014 16:02:14 +0100 Subject: [PATCH] * README.md: installation procedure --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 6d02ec78..9abc5998 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,23 @@ ucoin-python-api ================ A python implementation of uCoin API + +Installation +============ + +Here is a fast installation procedure (a bit dirty) we suggest to quickly use this API. + +```bash +$ cd $HOME +$ git clone git@github.com:canercandan/ucoin-python-api.git +$ export PYTHONPATH="$HOME/ucoin-python-api:$PYTHONPATH" +``` + +Thus you are ready to use it with your own python program. Here is an example illustrating how to use it thanks to the python shell: + +```python +import ucoin +ucoin.ucg.Peering().get() +``` + +Please take a look at the document [HTTP API](https://github.com/c-geek/ucoin/blob/master/doc/HTTP_API.md) to learn about the API. -- GitLab