Skip to content

docs: improve readme #109

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.

Sign up for GitHub

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

Merged
Frando merged 2 commits into from
Feb 25, 2025
Merged

docs: improve readme #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebcab70
docs: improve top-level readme
Frando Feb 25, 2025
90175f7
fixup
Frando Feb 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 20 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,37 +7,44 @@ For very experimental things there is [iroh-experiments].

## Examples

# Dumbpipe-web
### [browser-echo](browser-echo)

Use iroh in the browser, compiled to web assembly. [Try it here!](https://n0-computer.github.io/iroh-examples/main/browser-echo/index.html)

### [browser-chat](browser-chat)

A chat app based on iroh-gossip that can run both in the browser and on the command line.
[Try it here!](https://n0-computer.github.io/iroh-examples/main/browser-chat/index.html)

### [dumbpipe-web](dumbpipe-web)

Forward http requests to dumbpipe. Share a local dev server publicly.

# Extism
### [extism](extism)

Use iroh through [extism]

# Iroh-automerge
### [frosty](frosty)

Iroh integration with [automerge]
Experiment with [FROST] threshold signatures for iroh.

# Iroh-gateway
### [iroh-automerge](iroh-automerge)

A http gateway for iroh-blobs data, written using iroh-blobs.

# Iroh-pkarr-node-discovery
Iroh integration with [automerge]

Node discovery using the bittorrent [mainline] DHT and [pkarr].
### [iroh-gateway](iroh-gateway)

# Tauri-todos
A http gateway for iroh-blobs data, written using iroh-blobs.

Todo app using iroh documents and [tauri]
### [tauri-todos](tauri-todos)

# Browser-echo
Todo app using iroh documents and [tauri].

Use iroh in the browser, compiled to web assembly.

[iroh-experiments]: https://github.com/n0-computer/iroh-experiments
[extism]: https://extism.org/
[automerge]: https://automerge.org/
[mainline]: https://en.wikipedia.org/wiki/Mainline_DHT
[pkarr]: https://pkarr.org/
[tauri]: https://tauri.app/
[FROST]: https://eprint.iacr.org/2020/852.pdf
2 changes: 2 additions & 0 deletions browser-chat/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This is a chat app that runs in both the browser and the command line. It uses [`iroh-gossip`](https://github.com/n0-computer/iroh-gossip/) to send messages between peers sharing a channel.

We automatically deploy this example, you can **[try it out here](https://n0-computer.github.io/iroh-examples/main/browser-chat/index.html)**.

The example has the following parts:

* [**shared**](shared) is a Rust library that exposes a `ChatNode`, which uses iroh and iroh-gossip to power a simple ephemeral gossip chat between peers.
Expand Down
3 changes: 3 additions & 0 deletions browser-echo/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ The protocol and setup code is shared between the browser and the CLI.

## Run the browser version:

You can try out the **[deployed example](https://n0-computer.github.io/iroh-examples/main/browser-echo/index.html)**.
To build and run it yourself, follow these steps:

```sh
$ cargo install wasm-bindgen-cli
$ rustup target install wasm32-unknown-unknown
Expand Down