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

examples/README: Give an overview over the many examples #2194

Merged
merged 1 commit into from
Aug 16, 2021
Merged
Changes from all commits
Commits
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
51 changes: 51 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Examples

A set of examples showcasing how to use rust-libp2p.

## Getting started

- [Ping](ping.rs)

Small `ping` clone, sending a ping to a peer, expecting a pong as a response. See
[tutorial](../src/tutorial.rs) for a step-by-step guide building the example.

## Individual libp2p protocols

- [Chat](./chat.rs)

A basic chat application demonstrating libp2p and the mDNS and floodsub protocols.

- [Gossipsub chat](./gossipsub-chat.rs)

Same as the chat example but using the Gossipsub protocol.

- [Tokio based chat](./chat-tokio.rs)

Same as the chat example but using tokio for all asynchronous tasks and I/O.

- [Distributed key-value store](./distributed-key-value-store.rs)

A basic key value store demonstrating libp2p and the mDNS and Kademlia protocol.

- [IPFS Kademlia](ipfs-kad.rs)

Demonstrates how to perform Kademlia queries on the IPFS network.

- [IPFS Private](ipfs-private.rs)

Implementation using the gossipsub, ping and identify protocols to implement the ipfs private
swarms feature.

- [Passive Discovery via MDNS](mdns-passive-discovery.rs)

Discover peers on the same network via the MDNS protocol.

## Integration into a larger application

- [File sharing application](./file-sharing.rs)

Basic file sharing application with peers either providing or locating and getting files by name.

While obviously showcasing how to build a basic file sharing application with the Kademlia and
Request-Response protocol, the actual goal of this example is **to show how to integrate
rust-libp2p into a larger application**.