ericsomdahl / python-bittrex

Python bindings for bittrex
MIT License
585 stars 283 forks source link

update README.md #120

Closed SegFault42 closed 6 years ago

SegFault42 commented 6 years ago

small change in Readme.md

skyl commented 6 years ago

Prefer Python3 syntax for print. But, aside from that, I don't think print() should appear here. There could be a line in between explaining that the object is returned.

So, instead of:

from bittrex.bittrex import *

my_bittrex = Bittrex("<my_api_key>", "<my_api_secret>", api_version="<API_V1_1> or <API_V2_0>")

my_bittrex.get_balance('ETH')
{'success': True, 
 'message': '',
 'result': {'Currency': 'ETH', 'Balance': 0.0, 'Available': 0.0, 
            'Pending': 0.0, 'CryptoAddress': None}
}

It could be broken into 2 like:

from bittrex import Bittrex
my_bittrex = Bittrex("<my_api_key>", "<my_api_secret>", api_version="<API_V1_1> or <API_V2_0>")
my_bittrex.get_balance('ETH')

This call to get_balance returns an object such as the following:

{'success': True, 
 'message': '',
 'result': {'Currency': 'ETH', 'Balance': 0.0, 'Available': 0.0, 
            'Pending': 0.0, 'CryptoAddress': None}
}
SegFault42 commented 6 years ago

updated :+1:

skyl commented 6 years ago

Comment should appear outside of the code block: https://github.com/SegFault42/python-bittrex/blob/123c1ab52b06738df52c9845c0946c0e4c8e244d/README.md

skyl commented 6 years ago

LGTM