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 Nov 6, 2024
1 parent 233d41a commit bf46414
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions protocols/v2/subprotocols/common-messages/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# 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)

`common_messages_sv2` is a Rust crate that provides common messages used by different Stratum V2 protocol and roles.

This crate offers flag features to enable or disable the use of `std`, `serde` or `quickcheck`
dependencies.

## Usage

To include this crate in your project, run:

```sh
cargo add common_messages_sv2

0 comments on commit bf46414

Please sign in to comment.