chore(docs): update readme #2465
Conversation
README.md
Outdated
| <h1 align="center"><a href="https://iroh.computer"><img alt="iroh" src="./.img/iroh_wordmark.svg" width="100" /></a></h1> | ||
|
|
||
| <h3 align="center"> | ||
| Build distributed apps that raise the status quo for your users. |
There was a problem hiding this comment.
A toolkit for building distributed applications
should be the tagline
widget is enabled |
| @@ -38,9 +30,17 @@ Bytes, Distributed. | |||
| </div> | |||
| <br/> | |||
|
|
|||
| ## Features | |||
There was a problem hiding this comment.
Should we expand this with the full set of items instead of just the 3 layers? What should we include here?
There was a problem hiding this comment.
probably, but lets get the existing improvements merged now, and do that in a follow up
|
|
||
| - Documents - Authors create and join documents: mutable key-value stores that multiple users read from, write to, and sync with, subscribing to live updates in real time. | ||
| - Blobs - Iroh works with content-addressed blobs of opaque data, which are often the bytes of a file. | ||
| - Networking - At the core of iroh is the ability to connect any two devices, no matter where they are. |
There was a problem hiding this comment.
| - Networking - At the core of iroh is the ability to connect any two devices, no matter where they are. | |
| - Networking - At the core of iroh is the ability to reliably connect any two devices, no matter where they are, utilizing hole punching to establish peer to peer connections. |
May be a bit wordy, but that's some stuff I've liked about it so far.
There was a problem hiding this comment.
I like it, on the other hand, the above is taken directly from the iroh.computer site. Should we do it separately and try to keep it consistent?
There was a problem hiding this comment.
Good point. Yeah I'll open a PR for the website, and we can discuss with @b5 , too :)
## Description Is the tagline correct? Can we enable this discord widget? ## Breaking Changes <!-- Optional, if there are any breaking changes document them, including how to migrate older code. --> ## Notes & open questions <!-- Any notes, remarks or open questions you have to make about the PR. --> ## Change checklist - [ ] Self-review. - [ ] Documentation updates following the [style guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text), if relevant. - [ ] Tests if relevant. - [ ] All breaking changes documented.
Description
Is the tagline correct?
Can we enable this discord widget?
Breaking Changes
Notes & open questions
Change checklist