From 8cd634b26f09e17037c42e5b1db5af623af49627 Mon Sep 17 00:00:00 2001 From: Georges Palauqui Date: Wed, 13 Nov 2024 08:27:17 +0100 Subject: [PATCH] Add `no_std` in README --- protocols/v2/binary-sv2/binary-sv2/README.md | 3 +++ protocols/v2/binary-sv2/no-serde-sv2/codec/README.md | 3 +++ protocols/v2/binary-sv2/no-serde-sv2/derive_codec/README.md | 3 +++ protocols/v2/binary-sv2/serde-sv2/README.md | 3 +++ protocols/v2/const-sv2/README.md | 2 +- protocols/v2/framing-sv2/README.md | 3 +++ 6 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 protocols/v2/binary-sv2/no-serde-sv2/codec/README.md create mode 100644 protocols/v2/binary-sv2/no-serde-sv2/derive_codec/README.md create mode 100644 protocols/v2/binary-sv2/serde-sv2/README.md create mode 100644 protocols/v2/framing-sv2/README.md diff --git a/protocols/v2/binary-sv2/binary-sv2/README.md b/protocols/v2/binary-sv2/binary-sv2/README.md index e69de29bb..7fac0315f 100644 --- a/protocols/v2/binary-sv2/binary-sv2/README.md +++ b/protocols/v2/binary-sv2/binary-sv2/README.md @@ -0,0 +1,3 @@ +# binary_sv2 + +`binary_sv2` is a Rust `no_std` crate \ No newline at end of file diff --git a/protocols/v2/binary-sv2/no-serde-sv2/codec/README.md b/protocols/v2/binary-sv2/no-serde-sv2/codec/README.md new file mode 100644 index 000000000..f338a94db --- /dev/null +++ b/protocols/v2/binary-sv2/no-serde-sv2/codec/README.md @@ -0,0 +1,3 @@ +# binary_codec_sv2 + +`binary_codec_sv2` is a Rust `no_std` crate \ No newline at end of file diff --git a/protocols/v2/binary-sv2/no-serde-sv2/derive_codec/README.md b/protocols/v2/binary-sv2/no-serde-sv2/derive_codec/README.md new file mode 100644 index 000000000..01af2599e --- /dev/null +++ b/protocols/v2/binary-sv2/no-serde-sv2/derive_codec/README.md @@ -0,0 +1,3 @@ +# derive_codec_sv2 + +`derive_codec_sv2` is a Rust `no_std` crate \ No newline at end of file diff --git a/protocols/v2/binary-sv2/serde-sv2/README.md b/protocols/v2/binary-sv2/serde-sv2/README.md new file mode 100644 index 000000000..43a6706d0 --- /dev/null +++ b/protocols/v2/binary-sv2/serde-sv2/README.md @@ -0,0 +1,3 @@ +# serde_sv2 + +`serde_sv2` is a Rust `no_std` crate \ No newline at end of file diff --git a/protocols/v2/const-sv2/README.md b/protocols/v2/const-sv2/README.md index b49199745..3a414b3cc 100644 --- a/protocols/v2/const-sv2/README.md +++ b/protocols/v2/const-sv2/README.md @@ -5,7 +5,7 @@ [![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) -`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. +`const_sv2` is a Rust `no_std` 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. ## Key Capabilities diff --git a/protocols/v2/framing-sv2/README.md b/protocols/v2/framing-sv2/README.md new file mode 100644 index 000000000..26e617ed2 --- /dev/null +++ b/protocols/v2/framing-sv2/README.md @@ -0,0 +1,3 @@ +# framing_sv2 + +`framing_sv2` is a Rust `no_std` crate \ No newline at end of file