Rework readme - Githubissues

bitfinexcom / bitfinex-api-go

BITFINEX Go trading API - Bitcoin, Litecoin, and Ether exchange

https://www.bitfinex.com/

MIT License

303 stars 222 forks source link

Rework readme #198

Closed JacobPlaster closed 4 years ago

JacobPlaster commented 4 years ago

Description:

Cleans up readme and adds new doc files

Breaking changes:

None

New features:

[x] docs/rest_v2.md
[x] docs/v1.md
[x] docs/ws_v2.md
[x] New readme format
[x] Tonnes of new function comments

Fixes:

None

PR status:

~~Version bumped~~ - not required
~~Change-log updated~~ - not required

JacobPlaster commented 4 years ago

Otherwise it is not obvious what the library provides unless one scans the entire file.

Yeah completely agree, I really dont want to make this a manual process though. Hopefully there is a nice python package for parsing markdown that I can use

JacobPlaster commented 4 years ago

Created issue https://github.com/bitfinexcom/bitfinex-api-go/issues/199