From a88790841938d41e754a26762dd3431de15cbe31 Mon Sep 17 00:00:00 2001 From: Henry de Valence Date: Thu, 25 Jan 2018 14:31:56 -0800 Subject: [PATCH] Add note on yolocrypto stability --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8320066..69456c9 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,8 @@ Curve arithmetic is implemented using one of the following backends: * a `u32` backend using `u64` products; * a `u64` backend using `u128` products, available using the `nightly` feature; -* an experimental AVX2 backend, available using the `yolocrypto` feature when compiling for a target with `target_feature=+avx2` +* an experimental AVX2 backend, available using the `yolocrypto` feature when + compiling for a target with `target_feature=+avx2`. By default, the benchmarks are not compiled without the `bench` feature. Benchmarks can be run via: @@ -69,6 +70,10 @@ cargo bench --features="bench nightly" # u64 backend cargo bench --features="bench nightly yolocrypto" # u64 or avx2 if available ``` +The `yolocrypto` feature enables experimental features. The name `yolocrypto` +is meant to indicate that it is not considered production-ready, and we do not +consider `yolocrypto` features to be covered by semver guarantees. + # Contributing Please see [CONTRIBUTING.md][contributing].