From 4a54f66a48b6d30ace6c400b74b30001c389d054 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Wed, 4 Jul 2018 20:54:05 +0000 Subject: [PATCH] Move documentation of yolocrypto feature in README. --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5e59cfa..fe086d6 100644 --- a/README.md +++ b/README.md @@ -59,10 +59,6 @@ extern crate curve25519_dalek; # Backends and Features -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. - The `std` feature is enabled by default, but it can be disabled. The `nightly` feature enables nightly-only features. **It is recommended for security**. @@ -93,6 +89,13 @@ cargo bench --no-default-features --features "std u64_backend" cargo bench --no-default-features --features "std avx2_backend" ``` +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. +This is designed to make it easier to test intended new features +without having to stabilise them first. Use `yolocrypto` at your own, +obvious, risk. + # Contributing Please see [CONTRIBUTING.md][contributing].