Skip to content

Commit 67d2a6d

Browse files
committed
description updates
1 parent bab5c0c commit 67d2a6d

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,21 @@
33
Inspired by [this](http://pastebin.com/8fBVpjaj) wrapper written by 'oipminer'
44
> I (s4w3d0ff) am not affiliated with, nor paid by [Poloniex](https://poloniex.com). I found the linked python wrapper on the poloniex support page to be incomplete and buggy so I decided to write this wrapper and create a git repository. If you wish to contribute to the repository please read [CONTRIBUTING.md](https://github.com/s4w3d0ff/python-poloniex/blob/master/CONTRIBUTING.md). All and any help is appreciated.
55
6+
- [x] Python 2.7 and 3.5+
7+
- [x] Pypi
8+
- [x] Travis
9+
- [x] Websocket api support
10+
- [x] Minimal amount of dependencies
11+
- [x] Internal checks to reduce external api errors
12+
- [x] Rate limiter to keep from going over call limits
13+
- [x] Retries failed api calls during connection issues
14+
15+
### Install:
616
```
7-
pip install poloniexapi
17+
pip install --upgrade poloniexapi
818
```
919

10-
## Usage:
20+
### Usage:
1121
See the [wiki](https://github.com/s4w3d0ff/python-poloniex/wiki) or `help(poloniex)` for more.
1222

1323
All api calls are done through an instance of `poloniex.Poloniex`. You can use the instance as follows:

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
setup(name='poloniexapi',
66
version='0.5.3',
7-
description='Poloniex API wrapper for Python 2.7 and 3',
7+
description='Poloniex API wrapper for Python 2.7 and 3 with websocket support',
88
long_description=read_md('README.md'),
99
long_description_content_type='text/markdown',
1010
url='https://github.com/s4w3d0ff/python-poloniex',

0 commit comments

Comments
 (0)