From 32b89e9e0141ab71d8a5a7812d4c4c33cf312688 Mon Sep 17 00:00:00 2001 From: Slesarew Date: Wed, 20 Nov 2024 16:31:53 +0200 Subject: [PATCH] chore: readme and release metadata --- Cargo.toml | 13 ++++++++++++- README.md | 7 ++++--- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 174e3a8..f3e674c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,18 @@ [package] name = "substrate-crypto-light" +description = "Cryptographic code for Substrate chains in pure rust with better baremetal support" +license = "GPL-3.0-or-later" version = "0.1.0" +authors = [ + "Alexander Slesarev ", + "Vera Abramova ", +] +repository = "https://github.com/Alzymologist/substrate-crypto-light" +homepage = "https://github.com/Alzymologist/substrate-crypto-light" +documentation = "https://docs.rs/substrate-crypto-light" +keywords = ["no_std", "crypto", "substrate", "polkadot"] edition = "2021" +exclude = ["/for_tests", "/.github"] [dependencies] base58 = {version = "0.2.0"} @@ -20,7 +31,7 @@ zeroize = {version = "1.7.0", features = ["derive"]} [dev-dependencies] hex = "0.4.3" -mnemonic-external = {git = "https://github.com/Alzymologist/mnemonic-external"} +mnemonic-external = "0.1.0" sp-core = "34.0.0" [features] diff --git a/README.md b/README.md index 1318d71..a1d096f 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ +Cryptographic code for Substrate chains in pure rust with better baremetal support. + This is largely based on -[`sp_core`](https://docs.rs/sp-core/latest/sp_core/) crate. Draft. +[`sp_core`](https://docs.rs/sp-core/latest/sp_core/) crate. Key differences here: - no-std compatible with arm, - sr25519 supports external Rng, for usability on baremetal -- ecdsa support based on pure Rust crate `k256` (TODO need to transfer stuff - here from Kampela code, as of now), to avoid compiling difficulties +- ecdsa support based on pure Rust crate `k256`, to avoid compiling difficulties (original `sp-core` has ecdsa from `secp256k1` C wrapper crate and it does not compile on certain no-std targets and creates extremely large binary blob on others)