From 2c04eeb0a9d999417fb1023e68054f54881e5c3a Mon Sep 17 00:00:00 2001 From: jbesraa Date: Tue, 5 Nov 2024 17:13:53 +0200 Subject: [PATCH] Add README mining subprotocol --- protocols/v2/subprotocols/mining/README.md | 30 ++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 protocols/v2/subprotocols/mining/README.md diff --git a/protocols/v2/subprotocols/mining/README.md b/protocols/v2/subprotocols/mining/README.md new file mode 100644 index 0000000000..813cdfe61b --- /dev/null +++ b/protocols/v2/subprotocols/mining/README.md @@ -0,0 +1,30 @@ +# mining_sv2 + +[![crates.io](https://img.shields.io/crates/v/mining_sv2.svg)](https://crates.io/crates/mining_sv2) +[![docs.rs](https://docs.rs/mining_sv2/badge.svg)](https://docs.rs/mining_sv2) +[![rustc+](https://img.shields.io/badge/rustc-1.75.0%2B-lightgrey.svg)](https://blog.rust-lang.org/2023/12/28/Rust-1.75.0.html) +[![license](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](https://github.com/stratum-mining/stratum/blob/main/LICENSE.md) +[![codecov](https://codecov.io/gh/stratum-mining/stratum/branch/main/graph/badge.svg)](https://app.codecov.io/gh/stratum-mining/stratum/tree/main/protocols%2Fv2%2Fmining_sv2) + +`mining_sv2` is a Rust crate that implements a set of messages defined in the Mining protocol of Stratum V2. +The Mining protocol enables the distribution of work to mining devices and the submission of +proof-of-work results. + +For further information about the messages, please refer to [Stratum V2 documentation - Mining](https://stratumprotocol.org/specification/05-Mining-Protocol/). + +## Build Options + +This crate can be built with the following features: +- `no_std`: Disables the standard library. +- `with_serde`: Enables support for serialization and deserialization using Serde. + +**Note that `with_serde` feature flag is only used for the Message Generator, and deprecated for any +other kind of usage. It will likely be fully deprecated in the future.** + +## Usage + +To include this crate in your project, run: + +```bash +$ cargo add mining_sv2 +```