Merge pull request #32 from algorealmInc/docs-revamp

Merge file sharing example from docs-revamp
algorealmInc · May 16, 2024 · 1cb4542 · 1cb4542
2 parents fd77f89 + a525fc5
commit 1cb4542
Show file tree

Hide file tree

Showing 15 changed files with 1,142 additions and 1,234 deletions.
diff --git a/README.md b/README.md
@@ -33,7 +33,9 @@ Visit the deployed Rust docs [here](https://algorealminc.github.io/SwarmNL/swarm
   - Protocol specification and handlers
   - Event handlers for network events and logging
 
-  #### Example
+  ### Example
+
+  #### Setup a node
 
   ```rust
         //! Using the default node setup configuration and the default network event handler
@@ -124,7 +126,7 @@ Visit the deployed Rust docs [here](https://algorealminc.github.io/SwarmNL/swarm
   - A simple RPC mechanism to exchange data quickly between peers.
   - Gossiping: SwarmNL uses the Gossipsub 1.1 protocol, specified by the [libp2p spec](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md).
 
-  #### Example
+  #### Communicate with the network layer
 
   ```rust
         //! Communicate with remote nodes using the simple and familiar async-await paradigm.

diff --git a/client/Cargo.toml b/client/Cargo.toml
@@ -12,6 +12,7 @@ tokio = { version = "1.37.0", features = ["full"] }
 base58 = "0.2.0"
 
 [features]
+first-node = []
 second-node = []
 test-reading-node = []
 test-writing-node = []