saymrwulf/curve25519-dalek-source
1
0
Fork 0
mirror of https://github.com/saymrwulf/curve25519-dalek-source.git synced 2026-09-04 20:24:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Move documentation of yolocrypto feature in README.

Browse source
This commit is contained in:
Isis Lovecruft 2018-07-04 20:54:05 +00:00
parent ebf0801dfc
commit 4a54f66a48
Failed to extract signature
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -59,10 +59,6 @@ extern crate curve25519_dalek;
# Backends and Features # 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 `std` feature is enabled by default, but it can be disabled.
The `nightly` feature enables nightly-only features. **It is recommended for security**. 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" 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 # Contributing
Please see [CONTRIBUTING.md][contributing]. Please see [CONTRIBUTING.md][contributing].