Skip to content

README: Add Links to mentioned tech #6016

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

README: Add Links to mentioned tech #6016

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 15 additions & 7 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,27 @@ Each example includes its own README.md file with specific instructions on how t

## Individual libp2p features

- [Chat](./chat) A basic chat application demonstrating libp2p and the mDNS and Gossipsub protocols.
- [Distributed key-value store](./distributed-key-value-store) A basic key value store demonstrating libp2p and the mDNS and Kademlia protocol.
- [Chat](./chat) A basic chat application demonstrating libp2p and the [mDNS] and [Gossipsub] protocols.
- [Distributed key-value store](./distributed-key-value-store) A basic key value store demonstrating libp2p and the [mDNS] and [Kademlia] protocol.

- [File sharing application](./file-sharing) 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
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**.

- [IPFS Kademlia](./ipfs-kad) Demonstrates how to perform Kademlia queries on the IPFS network.
- [IPFS Kademlia](./ipfs-kad) Demonstrates how to perform [Kademlia] queries on the [IPFS] network.

- [IPFS Private](./ipfs-private) Implementation using the gossipsub, ping and identify protocols to implement the ipfs private swarms feature.
- [IPFS Private](./ipfs-private) Implementation using the [Gossipsub], ping and identify protocols to implement the [IPFS private swarms] feature.

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

- [Rendezvous](./rendezvous) Rendezvous Protocol. See [specs](https://github.com/libp2p/specs/blob/master/rendezvous/README.md).
- [Rendezvous](./rendezvous) [Rendezvous] Protocol. See [specs](https://github.com/libp2p/specs/blob/master/rendezvous/README.md).

[mDNS]: https://en.wikipedia.org/wiki/Multicast_DNS
[Gossipsub]: https://github.com/libp2p/specs/tree/master/pubsub/gossipsub
[Kademlia]: https://en.wikipedia.org/wiki/Kademlia
[Request-Response]: https://en.wikipedia.org/wiki/Request%E2%80%93response
[IPFS]: https://ipfs.tech/
[IPFS private swarms]: https://ethereum.stackexchange.com/questions/73914/replication-of-files-across-a-private-ipfs-network
[Rendezvous]: https://en.wikipedia.org/wiki/Rendezvous_protocol
Loading