From ddd1a8dec28cceebbba956eb216d8f8f100a024a Mon Sep 17 00:00:00 2001 From: Sarah Jamie Lewis Date: Mon, 16 Aug 2021 15:46:04 -0700 Subject: [PATCH] Remove deprecated nightly feature external_docs --- Cargo.toml | 2 +- README.md | 6 +++++- src/lib.rs | 5 ++--- 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index c24c891..c3a1872 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "fuzzytags" description = "a probabilistic cryptographic structure for metadata resistant tagging" -version = "0.5.0" +version = "0.6.0" repository = "https://git.openprivacy.ca/openprivacy/fuzzytags" authors = ["Sarah Jamie Lewis "] edition = "2018" diff --git a/README.md b/README.md index c411b5f..4daf9e8 100644 --- a/README.md +++ b/README.md @@ -194,10 +194,14 @@ of different approaches e.g.: ## Benchmarks -We use [criterion](https://crates.io/crates/criterion) for benchmarking, and benchmarks can run using `cargo bench` +We use [criterion](https://crates.io/crates/criterion) for benchmarking, and benchmarks can run using `cargo bench --bench fuzzy_tags_benches` Results will be in `target/criterion/report/index.html`. +To benchmark entangled tags run: + +`cargo bench --features "entangled" --bench entangled` + ### AVX2 This crate has support for the avx2 under the feature `simd`, to take advantage of this feature it is diff --git a/src/lib.rs b/src/lib.rs index 79a9c97..9d962a9 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,7 +1,6 @@ #![deny(missing_docs)] -#![feature(external_doc)] -#![doc(include = "../README.md")] -#![doc(include = "../ANONYMITY.md")] +#![doc = include_str!("../README.md")] +#![doc = include_str!("../ANONYMITY.md")] #![doc(html_logo_url = "https://git.openprivacy.ca/openprivacy/fuzzytags/media/branch/trunk/FuzzyTags_Logo.png")] use bit_vec::BitVec; use curve25519_dalek::constants::RISTRETTO_BASEPOINT_POINT; -- 2.25.1