Skip to content

Commit

Permalink
Add README.md ..
Browse files Browse the repository at this point in the history
Use the template README used across the different Stratum V2 protocol
crates to `common_messages_sv2` crate.
  • Loading branch information
jbesraa committed Dec 3, 2024
1 parent 860d198 commit 19651b5
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions protocols/v2/subprotocols/common-messages/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# common_messages_sv2

[![crates.io](https://img.shields.io/crates/v/common_messages_sv2.svg)](https://crates.io/crates/common_messages_sv2)
[![docs.rs](https://docs.rs/common_messages_sv2/badge.svg)](https://docs.rs/common_messages_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%2Fcommon_messages_sv2)

`common_messages_sv2` is a Rust crate that implements a set of messages shared across all Stratum V2 subprotocols.

For further information, please refer to [Stratum V2 documentation - Common Messages](https://stratumprotocol.org/specification/03-Protocol-Overview/#36-common-protocol-messages).

## Build Options

This crate can be built with the following features:

- `std`: Enables support for standard library features.
- `serde`: Enables support for serialization and deserialization using Serde.
- `quickcheck`: Enables support for property-based testing using QuickCheck.

*Note that `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 common_messages_sv2
```

0 comments on commit 19651b5

Please sign in to comment.