Skip to content

Commit 318bccd

Browse files
authored
docs: improve readme (#109)
1 parent 4146a38 commit 318bccd

File tree

3 files changed

+25
-13
lines changed

3 files changed

+25
-13
lines changed

README.md

+20-13
Original file line numberDiff line numberDiff line change
@@ -7,37 +7,44 @@ For very experimental things there is [iroh-experiments].
77

88
## Examples
99

10-
# Dumbpipe-web
10+
### [browser-echo](browser-echo)
11+
12+
Use iroh in the browser, compiled to web assembly. [Try it here!](https://n0-computer.github.io/iroh-examples/main/browser-echo/index.html)
13+
14+
### [browser-chat](browser-chat)
15+
16+
A chat app based on iroh-gossip that can run both in the browser and on the command line.
17+
[Try it here!](https://n0-computer.github.io/iroh-examples/main/browser-chat/index.html)
18+
19+
### [dumbpipe-web](dumbpipe-web)
1120

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

14-
# Extism
23+
### [extism](extism)
1524

1625
Use iroh through [extism]
1726

18-
# Iroh-automerge
27+
### [frosty](frosty)
1928

20-
Iroh integration with [automerge]
29+
Experiment with [FROST] threshold signatures for iroh.
2130

22-
# Iroh-gateway
31+
### [iroh-automerge](iroh-automerge)
2332

24-
A http gateway for iroh-blobs data, written using iroh-blobs.
25-
26-
# Iroh-pkarr-node-discovery
33+
Iroh integration with [automerge]
2734

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

30-
# Tauri-todos
37+
A http gateway for iroh-blobs data, written using iroh-blobs.
3138

32-
Todo app using iroh documents and [tauri]
39+
### [tauri-todos](tauri-todos)
3340

34-
# Browser-echo
41+
Todo app using iroh documents and [tauri].
3542

36-
Use iroh in the browser, compiled to web assembly.
3743

3844
[iroh-experiments]: https://github.com/n0-computer/iroh-experiments
3945
[extism]: https://extism.org/
4046
[automerge]: https://automerge.org/
4147
[mainline]: https://en.wikipedia.org/wiki/Mainline_DHT
4248
[pkarr]: https://pkarr.org/
4349
[tauri]: https://tauri.app/
50+
[FROST]: https://eprint.iacr.org/2020/852.pdf

browser-chat/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
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.
44

5+
We automatically deploy this example, you can **[try it out here](https://n0-computer.github.io/iroh-examples/main/browser-chat/index.html)**.
6+
57
The example has the following parts:
68

79
* [**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.

browser-echo/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ The protocol and setup code is shared between the browser and the CLI.
66

77
## Run the browser version:
88

9+
You can try out the **[deployed example](https://n0-computer.github.io/iroh-examples/main/browser-echo/index.html)**.
10+
To build and run it yourself, follow these steps:
11+
912
```sh
1013
$ cargo install wasm-bindgen-cli
1114
$ rustup target install wasm32-unknown-unknown

0 commit comments

Comments
 (0)