-
Notifications
You must be signed in to change notification settings - Fork 136
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
``` |