Skip to content

Commit

Permalink
docs: Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dirvine authored and joshuef committed Sep 4, 2023
1 parent d3c0dd9 commit 9de7c49
Showing 1 changed file with 56 additions and 2 deletions.
58 changes: 56 additions & 2 deletions sn_node/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,57 @@
# sn_node
Safe Network Node (sn_node)

Provides the `safenode` binary, the node implementation for Safe Network.
Overview

The sn_node directory provides the safenode binary, which is the node implementation for the Safe Network. This directory contains the core logic for node operations, including API definitions, error handling, event management, and data validation.

Table of Contents

Overview
Installation
Usage
Directory Structure
Testing
Contributing
Conventional Commits
License
Installation

Follow the main project's installation guide to set up the safenode binary.

Usage

To run the safenode binary, follow the instructions in the main project's usage guide.

Directory Structure

src/: Source code files
api.rs: API definitions
error.rs: Error types and handling
event.rs: Event-related logic
get_validation.rs: Validation for GET requests
put_validation.rs: Validation for PUT requests
replication.rs: Data replication logic
spends.rs: Logic related to spending tokens or resources
tests/: Test files
common/mod.rs: Common utilities for tests
data_with_churn.rs: Tests related to data with churn
sequential_transfers.rs: Tests for sequential data transfers
storage_payments.rs: Tests related to storage payments
verify_data_location.rs: Tests for verifying data locations
Testing

To run tests, navigate to the sn_node directory and execute:

`cargo test`

Contributing

Please feel free to clone and provide pull requests.

Conventional Commits

We follow the Conventional Commits specification for all commits. Make sure your commit messages adhere to this standard.

License

This project is licensed under the MIT License.

0 comments on commit 9de7c49

Please sign in to comment.