Skip to content

Commit b7a2abd

Browse files
authored
Merge pull request #7 from n0-computer/rae/docs-review2
Update examples documentation with new tutorials and improved descrip…
2 parents 1c57560 + 383286d commit b7a2abd

File tree

1 file changed

+51
-14
lines changed

1 file changed

+51
-14
lines changed

examples/examples.mdx

Lines changed: 51 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,69 @@
11
---
2-
title: "Examples"
2+
title: "Examples & Apps"
33
---
44

5+
## Tutorials
6+
7+
Step-by-step guides to learn how to build with iroh.
8+
9+
<Columns cols={2}>
10+
<Card
11+
title="chat"
12+
icon="comments"
13+
href="/examples/chat"
14+
>
15+
Build a p2p chat application in Rust from scratch
16+
</Card>
17+
<Card
18+
title="file transfer"
19+
icon="file-arrow-up"
20+
href="/protocols/blobs"
21+
>
22+
Build a peer-to-peer file transfer tool using iroh-blobs
23+
</Card>
24+
</Columns>
25+
26+
## Examples
27+
28+
Example code repositories demonstrating iroh usage.
529

630
<Columns cols={2}>
731
<Card
832
title="sendme"
9-
icon="image"
10-
href="https://www.iroh.computer/sendme"
33+
icon="share"
34+
href="https://github.com/n0-computer/sendme"
1135
>
12-
Sendme will connect your devices directly & transfer files,
13-
without any accounts or configuration.
36+
Example CLI tool for direct file transfers between devices
1437
</Card>
1538
<Card
16-
title="dumbpipe"
17-
icon="pipe"
18-
href="https://www.dumbpipe.dev/"
39+
title="callme"
40+
icon="phone"
41+
href="https://github.com/n0-computer/callme"
1942
>
20-
Punches through NATs, keeping your machines connected as network conditions change.
43+
Example voice and video calling application
2144
</Card>
22-
<Card
23-
title="chat"
24-
icon="comments"
25-
href="/examples/chat"
45+
<Card
46+
title="dumbpipe"
47+
icon="terminal"
48+
href="https://github.com/n0-computer/dumbpipe"
2649
>
27-
Tutorial on how to build a p2p chat, in rust, from scratch
50+
Example CLI for piping data between machines through NATs
2851
</Card>
52+
</Columns>
2953

54+
## Applications
55+
56+
Full applications built with iroh.
57+
58+
<Columns cols={2}>
59+
<Card
60+
title="alt sendme"
61+
icon="paper-plane"
62+
href="https://www.altsendme.com/"
63+
>
64+
AltSendme is a desktop app that connects your devices directly & transfer files,
65+
without any accounts or configuration.
66+
</Card>
3067
<Card
3168
title="godot"
3269
icon="gamepad"

0 commit comments

Comments
 (0)