Add comments about withdraws and quick start example

sammchardy · Oct 28, 2017 · 3ae3989 · 3ae3989
1 parent 26aa81e
commit 3ae3989
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/PYPIREADME.rst b/PYPIREADME.rst
@@ -37,6 +37,7 @@ Features
 - Response exception handling
 - Websocket handling
 - Symbol Depth Cache
+- Withdraw functionality
 - Order parameter validation based on Trade Rules
 
 Quick Start
@@ -66,6 +67,15 @@ Quick Start
     # get all symbol prices
     prices = client.get_all_tickers()
 
+    # withdraw 100 ETH
+    result = client.withdraw(
+        asset='ETH',
+        address='<eth_address>',
+        amount=100)
+
+    # fetch list of withdrawals
+    withdraws = client.get_withdraw_history()
+
     # start trade websocket
     def process_message(msg):
         print("message type:" + msg[e])

diff --git a/README.rst b/README.rst
@@ -37,6 +37,7 @@ Features
 - Response exception handling
 - Websocket handling
 - Symbol Depth Cache
+- Withdraw functionality
 - Order parameter validation based on Trade Rules
 
 Quick Start
@@ -66,6 +67,15 @@ Quick Start
     # get all symbol prices
     prices = client.get_all_tickers()
 
+    # withdraw 100 ETH
+    result = client.withdraw(
+        asset='ETH',
+        address='<eth_address>',
+        amount=100)
+
+    # fetch list of withdrawals
+    withdraws = client.get_withdraw_history()
+
     # start trade websocket
     def process_message(msg):
         print("message type:" + msg[e])