diff --git a/README.md b/README.md index 6d02ec78d58cb97467f95617e171fa2be4676132..9abc59989bba0d9bf9466490816978f350aff2ad 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.