Skip to content

Commit dd3fb5d

Browse files
authored
chore(README.md): Add Links to mentioned tech
Adds links to related tech mentioned in examples/README. This is useful to people new to the field, like me. Pull-Request: #6016.
1 parent 6b3c57a commit dd3fb5d

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

examples/README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,26 @@ Each example includes its own README.md file with specific instructions on how t
2424

2525
## Individual libp2p features
2626

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

3030
- [File sharing application](./file-sharing) Basic file sharing application with peers either providing or locating and getting files by name.
3131

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

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

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

4040
- [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.
4141

42-
- [Rendezvous](./rendezvous) Rendezvous Protocol. See [specs](https://github.com/libp2p/specs/blob/master/rendezvous/README.md).
42+
- [Rendezvous](./rendezvous) [Rendezvous] Protocol. See [specs](https://github.com/libp2p/specs/blob/master/rendezvous/README.md).
43+
44+
[mDNS]: https://github.com/libp2p/specs/blob/master/discovery/mdns.md
45+
[Gossipsub]: https://github.com/libp2p/specs/tree/master/pubsub/gossipsub
46+
[Kademlia]: https://github.com/libp2p/specs/blob/master/kad-dht/README.md
47+
[Request-Response]: https://en.wikipedia.org/wiki/Request%E2%80%93response
48+
[IPFS]: https://ipfs.tech/
49+
[Rendezvous]: https://github.com/libp2p/specs/blob/master/rendezvous/README.md

0 commit comments

Comments
 (0)