Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update API documentation for javascript client #940

Closed
taythebot opened this issue Feb 5, 2020 · 1 comment · Fixed by bcoin-org/bcoin-org.github.io#168
Closed

Update API documentation for javascript client #940

taythebot opened this issue Feb 5, 2020 · 1 comment · Fixed by bcoin-org/bcoin-org.github.io#168

Comments

@taythebot
Copy link

taythebot commented Feb 5, 2020

I just started using bcoin and had a bit of trouble figuring out how to set a remote host for the bclient library. It doesn't seem to be in documented at all.

This might be useful for new comers. I didn't see any other way to suggest an edit on the documentation so I'm submitting an issue here. If there is a better place please let me know!

URL: https://bcoin.io/api-docs/index.html#using-javascript-clients
Suggested Edit:

Config Type Required Description
network string true Network to use: main, testnet, regtest
host string false Host for API (Defaults to 127.0.0.1)
port int true bcoin socket port (specific for each network)
apiKey string true API secret
@taythebot taythebot changed the title Update API documentation Update API documentation for javascript client Feb 5, 2020
@pinheadmz
Copy link
Member

Thanks @defusevenue !

In the future you can open a PR here: https://github.com/bcoin-org/bcoin-org.github.io

I'll fix this one today.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants