From 9fe4d52f47ef0fe6342ccfa355c147721a3f7ccc Mon Sep 17 00:00:00 2001 From: Aravinth Manivannan Date: Sat, 14 Oct 2023 23:48:54 +0530 Subject: [PATCH] chore: rename pow_sha256 crate (this) to mcaptcha_pow_sha256 closes: https://git.batsense.net/mCaptcha/pow_sha256/issues/2 --- Cargo.lock | 22 +++++++++++----------- Cargo.toml | 4 ++-- README.md | 13 ++++++------- examples/simple.rs | 2 +- src/lib.rs | 2 +- 5 files changed, 21 insertions(+), 22 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index eaab37d..c190e50 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -155,6 +155,17 @@ version = "0.2.149" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "a08173bc88b7955d1b3145aa561539096c421ac8debde8cbc3612ec635fee29b" +[[package]] +name = "mcaptcha_pow_sha256" +version = "0.3.1" +dependencies = [ + "bincode", + "derive_builder", + "num", + "serde", + "sha2", +] + [[package]] name = "num" version = "0.4.1" @@ -233,17 +244,6 @@ dependencies = [ "autocfg", ] -[[package]] -name = "pow_sha256" -version = "0.3.1" -dependencies = [ - "bincode", - "derive_builder", - "num", - "serde", - "sha2", -] - [[package]] name = "proc-macro2" version = "1.0.69" diff --git a/Cargo.toml b/Cargo.toml index ae5e5e8..cfe299f 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,5 +1,5 @@ [package] -name = "pow_sha256" +name = "mcaptcha_pow_sha256" version = "0.3.1" authors = [ "Aravinth Manivannan ", "Robert Kornacki "] description = """ @@ -9,7 +9,7 @@ edition = "2021" keywords = ["mCaptcha", "PoW", "sha256", "proof-of-work"] readme = "README.md" license = "MIT OR Apache-2.0" -repository = "https://git.batsense.net/mCaptcha/pow_sha256" +repository = "https://git.batsense.net/mCaptcha/mcaptcha_pow_sha256" categories = ["captcha", "algorithms", "cryptography::cryptocurrencies"] diff --git a/README.md b/README.md index e69a021..d3fad91 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,8 @@ **NOTE: All versions prior to 0.3.1 produce broken PoWs, upgrade to latest version** -> pow_sha256's copy of `pow_sha256` by -> [robkorn](https://github.com/robkorn/pow_sha256) +> mcaptcha_pow_sha256 is a copy of `pow_sha256` by +> [robkorn](https://github.com/robkorn/mcaptcha_pow_sha256) > which is a modified version of [`pow` library](https://github.com/bddap/pow). > All copyrights belong to the original authors. @@ -23,7 +23,7 @@ crate can be used to prove work was done on a given serializable input. The input merely needs to implement `serde::Deserialize` to be used. This is a fork of the [`pow` library](https://github.com/bddap/pow) by -[@robkorn](https://github.com/robkorn/pow_sha256)) with some new +[@robkorn](https://github.com/robkorn/mcaptcha_pow_sha256)) with some new additions. Primary of these being: - PoW datatype now offers a constructor @@ -35,8 +35,7 @@ mostly just stylistic/ease of use improvements. ## Documentation -- [master-branch](https://mcaptcha.github.io/pow_sha256/pow_sha256/index.html) -- [All published versions](https://mcaptcha.org/docs/api/pow-sha256) +https://docs.rs/mcaptcha_pow_sha256 ## Examples @@ -44,7 +43,7 @@ Prove work specifically targeting a phrase. ```rust -use pow_sha256::{ConfigBuilder, PoW}; +use mcaptcha_pow_sha256::{ConfigBuilder, PoW}; fn main() { let config = ConfigBuilder::default() @@ -70,7 +69,7 @@ Prove more difficult work. This time targeting a time. // to find a nonce of the correct difficulty. -use pow_sha256::{ConfigBuilder, PoW}; +use mcaptcha_pow_sha256::{ConfigBuilder, PoW}; fn main() { let config = ConfigBuilder::default() diff --git a/examples/simple.rs b/examples/simple.rs index 5ba995d..2b6fa81 100644 --- a/examples/simple.rs +++ b/examples/simple.rs @@ -7,7 +7,7 @@ * See `Default` implementation for the default configuration. */ -use pow_sha256::{ConfigBuilder, PoW}; +use mcaptcha_pow_sha256::{ConfigBuilder, PoW}; fn main() { let config = ConfigBuilder::default() diff --git a/src/lib.rs b/src/lib.rs index 4da9db8..cf8b208 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -7,7 +7,7 @@ //! //! # Example: //! ```rust -//! use pow_sha256::{ConfigBuilder, PoW}; +//! use mcaptcha_pow_sha256::{ConfigBuilder, PoW}; //! //! fn main() { //! let config = ConfigBuilder::default() -- 2.39.5