search

ipfs-rust / ipfs-embed

A small embeddable ipfs implementation
348 stars 49 forks source link

Better documentation and tutorials #66

Open rklaehn opened 3 years ago

rklaehn commented 3 years ago

If I understand correctly, the intention is to have the ipfs-embed interface more or less stable from now on.

I think now would be a good time to write more documentation, including examples for how to use the different components.

amtoine commented 1 year ago

hello there :wave: :yum:

I think now would be a good time to write more documentation, including examples for how to use the different components.

is there anything being done in that direction? :open_mouth:

i am starting a new professional project about IPFS in rust :crab: to the best of the knowledge of my team and I, the rust implementations of IPFS boil down to

in the end, ipfs-rust/ipfs-embed looks very cool and promising but, to be honest, i'm completely lost in the project and even struggle running it :thinking:

i would love to see more documentation and a demo or end product to help users understand what the contribution of ipfs-rust/ipfs-embed is :relieved: :star:

  • writing the docs might lead to some improvements in the APIs
  • It would be very useful for people to get started with ipfs
  • If the examples are checked on build, that would provide additional insurance and incentives to keep the interface stable.

agree with all of these :+1: