orbitdb-archive / ipfs-log

Append-only log CRDT on IPFS
https://orbitdb.github.io/ipfs-log/
MIT License
399 stars 55 forks source link

More Info needed on documentation #115

Open joelamouche opened 6 years ago

joelamouche commented 6 years ago

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 commented 6 years ago

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.