Skip to content
This repository has been archived by the owner on Sep 30, 2023. It is now read-only.

More Info needed on documentation #115

Open
joelamouche opened this issue Feb 23, 2018 · 1 comment
Open

More Info needed on documentation #115

joelamouche opened this issue Feb 23, 2018 · 1 comment

Comments

@joelamouche
Copy link

Hi there,

First of all thanks a bunch for the great work you're doing.

I wanted to suggest some additions to the documentation:
-add the inputs of "new Log()" , which are (ipfs, id, entries, heads, clock, key, keys = []) if I understand well
-enphasize the use of
var multihash= await log.toMultihash(ipfs, log)
var logs1fromIPFS= await Log.fromMultihash(ipfs, multihash)
as a way to communicate log to another peer

Cheers

@haadcode
Copy link
Member

Thanks for the suggestions @joelamouche! I like them and agree these points should be emphasized in the docs.

Leaving this open for contributions and to get to it at some point.

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

No branches or pull requests

2 participants