Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): update readme #2465

Merged
merged 2 commits into from
Jul 8, 2024
Merged

chore(docs): update readme #2465

merged 2 commits into from
Jul 8, 2024

Conversation

Arqu
Copy link
Collaborator

@Arqu Arqu commented Jul 5, 2024

Description

Is the tagline correct?
Can we enable this discord widget?

Breaking Changes

Notes & open questions

Change checklist

  • Self-review.
  • Documentation updates following the style guide, if relevant.
  • Tests if relevant.
  • All breaking changes documented.

@Arqu Arqu added the docs Improvements or additions to documentation label Jul 5, 2024
@Arqu Arqu requested review from dignifiedquire and b5 July 5, 2024 13:52
@Arqu Arqu self-assigned this Jul 5, 2024
@Arqu Arqu marked this pull request as ready for review July 5, 2024 13:53
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A toolkit for building distributed applications

should be the tagline

@dignifiedquire
Copy link
Contributor

Screenshot 2024-07-05 at 17 29 15

widget is enabled

@@ -38,9 +30,17 @@ Bytes, Distributed.
</div>
<br/>

## Features
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we expand this with the full set of items instead of just the 3 layers? What should we include here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- 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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. Yeah I'll open a PR for the website, and we can discuss with @b5 , too :)

@dignifiedquire dignifiedquire added this to the v0.20.0 milestone Jul 8, 2024
@Arqu Arqu added this pull request to the merge queue Jul 8, 2024
Merged via the queue into main with commit 61f3f7e Jul 8, 2024
25 checks passed
@Arqu Arqu deleted the arqu/readme_bump branch July 8, 2024 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

3 participants