Skip to content

Commit 656035b

Browse files
committed
add intro & what is iroh
1 parent 9b84546 commit 656035b

File tree

2 files changed

+50
-16
lines changed

2 files changed

+50
-16
lines changed

index.mdx

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,41 +13,42 @@ description: "iroh establishes direct peer-to-peer connections whenever possible
1313
href="/quickstart"
1414
horizontal
1515
>
16-
Follow our three step quickstart guide.
16+
Follow our quickstart guide.
1717
</Card>
1818

1919
## Make it yours
2020

21-
Design your protocols to fit your needs.
21+
Add the protocols and topologies to fit your needs. Iroh is modular and
22+
composable, so you can pick and choose what you need.
2223

2324
<Columns cols={2}>
2425
<Card
25-
title="Edit locally"
26-
icon="pen-to-square"
27-
href="/development"
26+
title="Blobs protocol"
27+
icon="image"
28+
href="/protocols/blobs"
2829
>
29-
Edit your docs locally and preview them in real time.
30+
Store and transfer large binary files peer-to-peer.
3031
</Card>
3132
<Card
32-
title="Customize your site"
33-
icon="palette"
34-
href="/essentials/settings"
33+
title="Key-Value CRDTs"
34+
icon="computer"
35+
href="/protocols/kv-crdts"
3536
>
36-
Customize the design and colors of your site to match your brand.
37+
Collaborative key-value store with conflict-free replication.
3738
</Card>
3839
<Card
39-
title="Set up navigation"
40-
icon="map"
41-
href="/essentials/navigation"
40+
title="Streaming"
41+
icon="video"
42+
href="/protocols/streaming"
4243
>
43-
Organize your docs to help users find what they need and succeed with your product.
44+
Build low-latency peer-to-peer audio and video streaming applications.
4445
</Card>
4546
<Card
4647
title="API documentation"
4748
icon="terminal"
48-
href="/api-reference/introduction"
49+
href="https://docs.rs/iroh"
4950
>
50-
Auto-generate API documentation from OpenAPI specifications.
51+
Explore the full iroh Rust API documentation.
5152
</Card>
5253
</Columns>
5354

what-is-iroh.mdx

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,36 @@
11
---
22
title: "What is iroh?"
33
---
4+
5+
iroh is a modular peer-to-peer networking stack written in Rust. It provides
6+
the building blocks to create decentralized applications that can communicate
7+
securely and efficiently over the internet.
8+
9+
## Core features
10+
- **Peer-to-peer connectivity**: iroh enables direct connections between
11+
devices, allowing them to communicate without relying on centralized servers.
12+
It uses relay servers as a fallback when direct connections are not possible.
13+
- **Secure communication**: All connections established through iroh are
14+
authenticated and encrypted end-to-end using the QUIC protocol, ensuring data
15+
privacy and integrity.
16+
- **Modular protocols**: iroh is built around a system of composable protocols
17+
that can be mixed and matched to suit the needs of different applications. This
18+
allows developers to easily add functionality such as file sharing, messaging,
19+
and real-time collaboration.
20+
21+
## Use cases
22+
- **Decentralized applications**: iroh provides the networking foundation for
23+
building decentralized applications that can operate without central servers.
24+
- **File sharing**: With protocols like iroh-blobs, iroh enables efficient
25+
peer-to-peer file sharing.
26+
- **Real-time collaboration**: iroh's support for flexible data protocols allows
27+
developers to build applications that support real-time collaborative editing
28+
and data synchronization. Any kind of CRDT or OT sync protocol can be integrated.
29+
30+
## Getting started
31+
To get started with iroh, check out the [quickstart guide](/quickstart) or explore the
32+
[protocols documentation](/protocols) to see what protocols are available and
33+
how to use them in your applications.
34+
35+
Read the [how it works documentation](/concepts) to understand the underlying
36+
principles and architecture of iroh.

0 commit comments

Comments
 (0)