docs: more doc updates to readme files

README.md

@@ -219,3 +219,17 @@ Each CashNote is written to a separate file in respective recipient public addre
 Use the `open-metrics` feature flag on the node / client to start an [OpenMetrics](https://github.com/OpenObservability/OpenMetrics/) exporter. The metrics are served via a webserver started at a random port. Check the log file / stdout to find the webserver URL, `Metrics server on http://127.0.0.1:xxxx/metrics`
 
 The metrics can then be collected using a collector (for e.g. Prometheus) and the data can then be imported into any visualization tool (for e.g., Grafana) to be further analyzed. Refer to this [Guide](./metrics/README.md) to easily setup a dockerized Grafana dashboard to visualize the metrics.
+
+
+
+## Contributing
+
+Please feel free to clone and modify this project. Pull requests are welcome.
+
+## Conventional Commits
+
+We follow the [Conventional Commits](https://www.conventionalcommits.org/) specification for all commits. Make sure your commit messages adhere to this standard.
+
+## License
+
+This Safe Network repository is licensed under the General Public License (GPL), version 3 ([LICENSE](LICENSE) http://www.gnu.org/licenses/gpl-3.0.en.html).

sn_cli/README.md

@@ -1,3 +1,10 @@
 # sn_cli
 
-Provides the `safe` client binary, used for participating in the Safe Network.
+This directory contains the `safe` client binary. It is used to interact with the Safe Network and provides a range of commands for managing data, keys, wallets, and more.
+
+The `safe` binary includes the following subcommands:
+
+- `wallet`: Commands for wallet management. This includes creating wallets, checking balances, and making transactions.
+- `files`: Commands for file management. This includes uploading, downloading, and deleting files.
+- `register`: Commands for register management. This includes creating, reading, and writing to registers.
+- `gossipsub`: Commands for gossipsub management. This includes subscribing to topics and publishing messages.

sn_client/README.md

@@ -109,4 +109,4 @@ We follow the [Conventional Commits](https://www.conventionalcommits.org/) speci
 
 ## License
 
-This project is licensed under the [MIT License](LICENSE).
+This Safe Network repository is licensed under the General Public License (GPL), version 3 ([LICENSE](LICENSE) http://www.gnu.org/licenses/gpl-3.0.en.html).

sn_node/README.md

@@ -59,7 +59,8 @@ We follow the [Conventional Commits](https://www.conventionalcommits.org/) speci
 
 ## License
 
-This project is licensed under the [MIT License](LICENSE).
+This Safe Network repository is licensed under the General Public License (GPL), version 3 ([LICENSE](LICENSE) http://www.gnu.org/licenses/gpl-3.0.en.html).
+
 
 ---
 

sn_peers_acquisition/README.md

@@ -1,3 +1,5 @@
 # sn_peers_acquisition
 
-Provides utilities for peer acquisition.
+Provides utilities for discovering bootstrap peers on a given system.
+
+It handles `--peer` arguments across all bins, as well as `SAFE_PEERS` or indeed picking up an initial set of `network-conacts` from a provided, or hard-coded url.

sn_transfers/README.md

@@ -1,3 +1,17 @@
 # sn_transfers
 
-Provides utilities for working with transfers on the Safe Network.
+The `sn_transfers` crate is responsible for managing transfers within the Safe Network. 
+
+Its main component is the [`CashNote`](https://github.com/maidsafe/sn_transfers/blob/main/src/cash_note.rs), which forms the basis of transfers on the Safe Network.
+
+A `CashNote` represents a spendable unit of currency in the network, denoting ownership of a certain number of `NanoTokens`.
+
+To execute a transfer, a [`SignedSpend`](https://github.com/maidsafe/sn_transfers/blob/main/src/signed_spend.rs) needs to be created and validated on the network.
+
+`Transfer`s are directed to `UniquePubKey`s, which are derived from `MainPubKey`s. Using a `DerivationIndex`, the recipient can generate the necessary `SecretKey` to spend the `NanoTokens`.
+
+Since most of the required information is stored in a `SignedSpend` on the network, we also provide a [`CashNoteRedemption`](https://github.com/maidsafe/sn_transfers/blob/main/src/cash_note_redemption.rs) struct. This struct contains the minimum information needed to retrieve a full `Spend` from the network and generate the keys required to spend the `NanoTokens`.
+
+For error handling, we expose [`Error`](https://github.com/maidsafe/sn_transfers/blob/main/src/error.rs) and [`Result`](https://github.com/maidsafe/sn_transfers/blob/main/src/result.rs) types.
+
+Additionally, this crate re-exports the `bls` crate used in the public API and includes a helper module for creating an Rng when invoking `sn_transfers` methods that require them.