diff --git a/examples/README.md b/examples/README.md index b1fb9f1f104..2e397960b76 100644 --- a/examples/README.md +++ b/examples/README.md @@ -24,19 +24,26 @@ 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://github.com/libp2p/specs/blob/master/discovery/mdns.md +[Gossipsub]: https://github.com/libp2p/specs/tree/master/pubsub/gossipsub +[Kademlia]: https://github.com/libp2p/specs/blob/master/kad-dht/README.md +[Request-Response]: https://en.wikipedia.org/wiki/Request%E2%80%93response +[IPFS]: https://ipfs.tech/ +[Rendezvous]: https://github.com/libp2p/specs/blob/master/rendezvous/README.md