examples: employ consistent naming

Resolves: #4459. Pull-Request: #4533.
libp2p · Sep 21, 2023 · 2157052 · 2157052
1 parent c97f86f
commit 2157052
Show file tree

Hide file tree

Showing 16 changed files with 20 additions and 20 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -3,15 +3,15 @@ members = [
     "core",
     "examples/autonat",
     "examples/browser-webrtc",
-    "examples/chat-example",
+    "examples/chat",
     "examples/dcutr",
     "examples/distributed-key-value-store",
     "examples/file-sharing",
     "examples/identify",
     "examples/ipfs-kad",
     "examples/ipfs-private",
     "examples/metrics",
-    "examples/ping-example",
+    "examples/ping",
     "examples/relay-server",
     "examples/rendezvous",
     "examples/upnp",

diff --git a/examples/README.md b/examples/README.md
@@ -7,7 +7,7 @@ A set of examples showcasing how to use rust-libp2p.
 
 ## Individual libp2p features
 
-- [Chat](./chat-example) A basic chat application demonstrating libp2p and the mDNS and Gossipsub protocols.
+- [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.
@@ -20,6 +20,6 @@ A set of examples showcasing how to use rust-libp2p.
 
 - [IPFS Private](./ipfs-private) Implementation using the gossipsub, ping and identify protocols to implement the ipfs private swarms feature.
 
-- [Ping](./ping-example) Small `ping` clone, sending a ping to a peer, expecting a pong as a response. See [tutorial](../src/tutorials/ping.rs) for a step-by-step guide building the example.
+- [Ping](./ping) Small `ping` clone, sending a ping to a peer, expecting a pong as a response. See [tutorial](../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).
diff --git a/examples/chat-example/Cargo.toml → examples/chat/Cargo.toml b/examples/chat-example/Cargo.toml → examples/chat/Cargo.toml
diff --git a/examples/chat-example/README.md → examples/chat/README.md b/examples/chat-example/README.md → examples/chat/README.md
diff --git a/examples/chat-example/src/main.rs → examples/chat/src/main.rs b/examples/chat-example/src/main.rs → examples/chat/src/main.rs
diff --git a/examples/dcutr/Cargo.toml b/examples/dcutr/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "dcutr"
+name = "dcutr-example"
 version = "0.1.0"
 edition = "2021"
 publish = false

diff --git a/examples/distributed-key-value-store/Cargo.toml b/examples/distributed-key-value-store/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "distributed-key-value-store"
+name = "distributed-key-value-store-example"
 version = "0.1.0"
 edition = "2021"
 publish = false

diff --git a/examples/file-sharing/Cargo.toml b/examples/file-sharing/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "file-sharing"
+name = "file-sharing-example"
 version = "0.1.0"
 edition = "2021"
 publish = false

diff --git a/examples/identify/Cargo.toml b/examples/identify/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "identify"
+name = "identify-example"
 version = "0.1.0"
 edition = "2021"
 publish = false

diff --git a/examples/ipfs-kad/Cargo.toml b/examples/ipfs-kad/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "ipfs-kad"
+name = "ipfs-kad-example"
 version = "0.1.0"
 edition = "2021"
 publish = false

diff --git a/examples/ipfs-private/Cargo.toml b/examples/ipfs-private/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "ipfs-private"
+name = "ipfs-private-example"
 version = "0.1.0"
 edition = "2021"
 publish = false

diff --git a/examples/ping-example/Cargo.toml → examples/ping/Cargo.toml b/examples/ping-example/Cargo.toml → examples/ping/Cargo.toml
diff --git a/examples/ping-example/README.md → examples/ping/README.md b/examples/ping-example/README.md → examples/ping/README.md
diff --git a/examples/ping-example/src/main.rs → examples/ping/src/main.rs b/examples/ping-example/src/main.rs → examples/ping/src/main.rs
diff --git a/libp2p/src/tutorials/hole_punching.rs b/libp2p/src/tutorials/hole_punching.rs
@@ -122,16 +122,16 @@
 //!
 //! ``` bash
 //! ## Inside the rust-libp2p repository.
-//! cargo build --bin dcutr
+//! cargo build --bin dcutr-example
 //! ```
 //!
-//! You can find the binary at `target/debug/dcutr`. In case you built it locally, copy
+//! You can find the binary at `target/debug/dcutr-example`. In case you built it locally, copy
 //! it to your listening client machine.
 //!
 //! On the listening client machine:
 //!
 //! ``` bash
-//! RUST_LOG=info ./dcutr --secret-key-seed 1 --mode listen --relay-address /ip4/$RELAY_SERVER_IP/tcp/4001/p2p/12D3KooWDpJ7As7BWAwRMfu1VU2WCqNjvq387JEYKDBj4kx6nXTN
+//! RUST_LOG=info ./dcutr-example --secret-key-seed 1 --mode listen --relay-address /ip4/$RELAY_SERVER_IP/tcp/4001/p2p/12D3KooWDpJ7As7BWAwRMfu1VU2WCqNjvq387JEYKDBj4kx6nXTN
 //!
 //! [2022-05-11T10:38:52Z INFO  client] Local peer id: PeerId("XXX")
 //! [2022-05-11T10:38:52Z INFO  client] Listening on "/ip4/127.0.0.1/tcp/44703"
@@ -153,7 +153,7 @@
 //! ## Connecting to the listening client from the dialing client
 //!
 //! ``` bash
-//! RUST_LOG=info ./dcutr --secret-key-seed 2 --mode dial --relay-address /ip4/$RELAY_SERVER_IP/tcp/4001/p2p/12D3KooWDpJ7As7BWAwRMfu1VU2WCqNjvq387JEYKDBj4kx6nXTN --remote-peer-id 12D3KooWPjceQrSwdWXPyLLeABRXmuqt69Rg3sBYbU1Nft9HyQ6X
+//! RUST_LOG=info ./dcutr-example --secret-key-seed 2 --mode dial --relay-address /ip4/$RELAY_SERVER_IP/tcp/4001/p2p/12D3KooWDpJ7As7BWAwRMfu1VU2WCqNjvq387JEYKDBj4kx6nXTN --remote-peer-id 12D3KooWPjceQrSwdWXPyLLeABRXmuqt69Rg3sBYbU1Nft9HyQ6X
 //! ```
 //!
 //! You should see the following logs appear: