Skip to content
This repository has been archived by the owner on Apr 3, 2019. It is now read-only.

Update readme #42

Closed
wants to merge 1 commit into from
Closed

Update readme #42

wants to merge 1 commit into from

Conversation

braydonf
Copy link
Contributor

No description provided.


## Getting Started

This library is distributed in both the npm and bower packaging systems.

```sh
npm install bitcore-lib
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Must you require('bitcore-lib') in order to use bitcore-mnemonic now?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Likely not directly, however I think it's good to do so that dependencies are setup already.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok. I feel like it would make more sense if bitcore-lib was used somewhere in an example to show why you should require it.

As is, with no explanation or usage example, it seems like "I need to require this in order to use bitcore-mnemonic"

(ie. The other day I was making a small app to show a proof of concept with bitcoinjs-lib, but I personally like the mnemonic library here, so I would use the HDnode object from bitcoinjs-lib with Mnemonic.toHDPrivateKey().toWIF() and import that. If I had seen something like this from the start, I would have assumed I need to import bitcore-lib as well in order to make mnemonics work)

Just a suggestion: Maybe add a short example that uses something from bitcore-lib to show its utility in the context of manipulating Mnemonics / the related HD keys.

@matiu
Copy link
Contributor

matiu commented Nov 30, 2018

See #69

@matiu matiu closed this Nov 30, 2018
@braydonf braydonf deleted the readme branch November 30, 2018 22:35
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants