diff --git a/examples/circuitrelay.nim b/examples/circuitrelay.nim index 617366706..b60960962 100644 --- a/examples/circuitrelay.nim +++ b/examples/circuitrelay.nim @@ -1,7 +1,7 @@ ## # Circuit Relay example ## ## Circuit Relay can be used when a node cannot reach another node -## directly, but can reach it through a another node (the Relay). +## directly, but can reach it through another node (the Relay). ## ## That may happen because of NAT, Firewalls, or incompatible transports. ## diff --git a/examples/go-daemon/daemonapi.md b/examples/go-daemon/daemonapi.md index 2e730b89b..cdeb03704 100644 --- a/examples/go-daemon/daemonapi.md +++ b/examples/go-daemon/daemonapi.md @@ -26,7 +26,7 @@ We recommend using `1.15.15`, as previously stated. ./scripts/build_p2pd.sh ``` If everything goes correctly, the binary (`p2pd`) should be built and placed in the correct directory. -If you find any issues, please head into our discord and ask for our asistance. +If you find any issues, please head into our discord and ask for our assistance. After successfully building the binary, remember to add it to your path so it can be found. You can do that by running: ```sh diff --git a/examples/tutorial_1_connect.nim b/examples/tutorial_1_connect.nim index b44359f72..17e73b2f8 100644 --- a/examples/tutorial_1_connect.nim +++ b/examples/tutorial_1_connect.nim @@ -34,7 +34,7 @@ import libp2p/protocols/ping ## [chronos](https://github.com/status-im/nim-chronos) the asynchronous framework used by `nim-libp2p` ## -## Next, we'll create an helper procedure to create our switches. A switch needs a bit of configuration, and it will be easier to do this configuration only once: +## Next, we'll create a helper procedure to create our switches. A switch needs a bit of configuration, and it will be easier to do this configuration only once: proc createSwitch(ma: MultiAddress, rng: ref HmacDrbgContext): Switch = var switch = SwitchBuilder .new() @@ -77,7 +77,7 @@ proc main() {.async.} = ## Now that we've started the nodes, they are listening for incoming peers. ## We can find out which port was attributed, and the resulting local addresses, by using `switch1.peerInfo.addrs`. ## - ## We'll **dial** the first switch from the second one, by specifying it's **Peer ID**, it's **MultiAddress** and the **`Ping` protocol codec**: + ## We'll **dial** the first switch from the second one, by specifying its **Peer ID**, its **MultiAddress** and the **`Ping` protocol codec**: let conn = await switch2.dial(switch1.peerInfo.peerId, switch1.peerInfo.addrs, PingCodec) ## We now have a `Ping` connection setup between the second and the first switch, we can use it to actually ping the node: # ping the other node and echo the ping duration diff --git a/examples/tutorial_2_customproto.nim b/examples/tutorial_2_customproto.nim index 3ba1e1ba2..2fff7090c 100644 --- a/examples/tutorial_2_customproto.nim +++ b/examples/tutorial_2_customproto.nim @@ -18,8 +18,8 @@ type TestProto = ref object of LPProtocol ## We've set a [protocol ID](https://docs.libp2p.io/concepts/protocols/#protocol-ids), and created a custom `LPProtocol`. In a more complex protocol, we could use this structure to store interesting variables. ## -## A protocol generally has two part: and handling/server part, and a dialing/client part. -## Theses two parts can be identical, but in our trivial protocol, the server will wait for a message from the client, and the client will send a message, so we have to handle the two cases separately. +## A protocol generally has two parts: a handling/server part, and a dialing/client part. +## These two parts can be identical, but in our trivial protocol, the server will wait for a message from the client, and the client will send a message, so we have to handle the two cases separately. ## ## Let's start with the server part: @@ -41,7 +41,7 @@ proc new(T: typedesc[TestProto]): T = proc hello(p: TestProto, conn: Connection) {.async.} = await conn.writeLp("Hello p2p!") -## Again, pretty straight-forward, we just send a message on the connection. +## Again, pretty straightforward, we just send a message on the connection. ## ## We can now create our main procedure: proc main() {.async.} = diff --git a/examples/tutorial_4_gossipsub.nim b/examples/tutorial_4_gossipsub.nim index 0e8274caf..abb10f2f3 100644 --- a/examples/tutorial_4_gossipsub.nim +++ b/examples/tutorial_4_gossipsub.nim @@ -7,7 +7,7 @@ ## and allows to balance between latency, bandwidth usage, ## privacy and attack resistance. ## -## You'll find a good explanation on how GossipSub works +## You'll find a good explanation of how GossipSub works ## [here.](https://docs.libp2p.io/concepts/publish-subscribe/) There are a lot ## of parameters you can tweak to adjust how GossipSub behaves but here we'll ## use the sane defaults shipped with libp2p. diff --git a/examples/tutorial_5_discovery.nim b/examples/tutorial_5_discovery.nim index a84a79877..a059d1ca3 100644 --- a/examples/tutorial_5_discovery.nim +++ b/examples/tutorial_5_discovery.nim @@ -2,7 +2,7 @@ ## ## In the [previous tutorial](tutorial_4_gossipsub.md), we built a custom protocol using [protobuf](https://developers.google.com/protocol-buffers) and ## spread informations (some metrics) on the network using gossipsub. -## For this tutorial, on the other hand, we'll go back on a simple example +## For this tutorial, on the other hand, we'll go back to a simple example ## we'll try to discover a specific peers to greet on the network. ## ## First, as usual, we import the dependencies: diff --git a/examples/tutorial_6_game.nim b/examples/tutorial_6_game.nim index c8fecdc7f..046c5b324 100644 --- a/examples/tutorial_6_game.nim +++ b/examples/tutorial_6_game.nim @@ -186,7 +186,7 @@ proc networking(g: Game) {.async.} = "/tron/matchmaking", proc (topic: string, data: seq[byte]) {.async.} = # If we are still looking for an opponent, - # try to match anyone broadcasting it's address + # try to match anyone broadcasting its address if g.peerFound.finished or g.hasCandidate: return g.hasCandidate = true