Skip to content

Commit

Permalink
README update to comply with docs standards
Browse files Browse the repository at this point in the history
  • Loading branch information
GitGab19 committed Oct 9, 2024
1 parent c05d8cd commit 4c0ee1f
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
2 changes: 1 addition & 1 deletion protocols/v2/const-sv2/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name = "const_sv2"
version = "2.0.0"
authors = ["fi3 <[email protected]>"]
edition = "2018"
description = "Sv2 constatnts"
description = "SV2 constants"
license = "MIT"
repository = "https://github.com/stratum-mining/stratum"

Expand Down
12 changes: 7 additions & 5 deletions protocols/v2/const-sv2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@

[![crates.io](https://img.shields.io/crates/v/const_sv2.svg)](https://crates.io/crates/const_sv2)
[![docs.rs](https://docs.rs/const_sv2/badge.svg)](https://docs.rs/const_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)
[![docs.rs](https://codecov.io/gh/stratum-mining/stratum/branch/main/graph/badge.svg)](https://app.codecov.io/gh/stratum-mining/stratum/tree/main/protocols%2Fv2%2Fconst-sv2)

`const_sv2` is a Rust crate that provides essential constants for the SV2 (Stratum V2) protocol. These constants are crucial for message framing, encryption, and protocol-specific identifiers across various SV2 components, including Mining, Job Declaration, and Template Distribution protocols.

## Main Components
## Key Capabilities

- **Protocol Constants**: Define key protocol discriminants, message types, and sizes for the SV2 binary protocol.
- **Encryption Support**: Includes constants for encryption using ChaChaPoly and ElligatorSwift encoding.
Expand All @@ -14,8 +17,7 @@

## Usage

To use this crate, add it to your `Cargo.toml`:
To include this crate in your project, you can run the following command in your terminal:

```toml
[dependencies]
const_sv2 = "2.0.0"
```bash
cargo add const_sv2

0 comments on commit 4c0ee1f

Please sign in to comment.