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 17, 2024
1 parent c6568e2 commit aa72fcd
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions protocols/v2/subprotocols/common-messages/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# 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 shared messages used by multiple Stratum V2 roles.

## Usage

To include this crate in your project, run:

```bash
$ cargo add common_messages_sv2
```

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

0 comments on commit aa72fcd

Please sign in to comment.