fluencelabs/js-peer-id
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-peer-id synced 2025-06-26 13:51:52 +00:00
Code Issues Projects Releases Wiki Activity

docs: various readme tweaks

Browse Source
This commit is contained in:
Maciej Krüger
2018-10-12 18:00:53 +02:00
parent bd1dc9bda0
commit 6ecd9a8cb0
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -144,6 +144,7 @@ Creates a Peer ID from hex string representing the key's multihash.
Creates a Peer ID from a buffer representing the key's multihash.
### `createFromB58String(str)`
Creates a Peer ID from a Base58 string representing the key's multihash.
### `createFromPubKey(pubKey)`
@ -161,8 +162,8 @@ Creates a Peer ID from a buffer containing a private key.
### `createFromJSON(obj)`
- `obj.id: String` - The multihash encoded in `base58`
- `obj.pubKey: String` - The public key in protobuf format, encoded in 'base64'
- `obj.privKey: String` - The private key in protobuf format, encoded in 'base 64'
- `obj.pubKey: String` - The public key in protobuf format, encoded in `base64`
- `obj.privKey: String` - The private key in protobuf format, encoded in `base64`
## Export
@ -198,10 +199,9 @@ Returns an `obj` of the form
- `obj.pubKey: String` - The public key in protobuf format, encoded in 'base64'
- `obj.privKey: String` - The private key in protobuf format, encoded in 'base 64'
### `toPrint()`
Returns the Peer ID as a printable string.
Returns the Peer ID as a printable string without the `Qm` prefix.
Example: `<peer.ID xxxxxx>`