iroh icon indicating copy to clipboard operation
iroh copied to clipboard

Published 20 hours ago • verified publisher icon n0-computer

project status / docs

Open lizelive opened this issue 3 years ago • 2 comments

really interested in this project. it would increase interest and usage, if the readme answered:

  • [ ] what is the lifecycle status of this project?
  • [ ] how is this project being funded?
  • [ ] why isn't it on crates.io?
  • [ ] where are the docs for this project? a gitbook repo? but don't see a built version. or link to it.
  • [ ] are their any benchmarks compared to kubo for for large (image, video) files?

lizelive avatar Aug 24 '22 19:08 lizelive

I think most of your questions are answered by the fact that it's in an early development phase. No time to document and really no use documenting an api if things change rapidly.

ralphtheninja avatar Aug 25 '22 10:08 ralphtheninja

@ralphtheninja is largely correct. It's early days for this project, and we're busy working toward an initial release, which will come with a proper docs site. In the meantime I've opened #216 to answer your questions & clarify the status of the project.

I've also deleted the iroh_docs repo, it's already stale to the point of being misleading. We'll be sure to update the readme with a link to docs once they're up, which we expect will be in October.

b5 avatar Sep 01 '22 02:09 b5