diff --git a/Cargo.toml b/Cargo.toml index 778a0c6..c0457a2 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,5 +1,7 @@ [package] name = "pairing" + +# Remember to change version string in README.md. version = "0.11.0" authors = ["Sean Bowe "] license = "MIT/Apache-2.0" diff --git a/README.md b/README.md index 538a5c5..21086e8 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,20 @@ This is a Rust crate for using pairing-friendly elliptic curves. Currently, only ## [Documentation](https://docs.rs/pairing/) +Bring the `pairing` crate into your project just as you normally would. + +If you're using a supported platform and the nightly Rust compiler, you can enable the `u128-support` feature for faster arithmetic. + +```toml +[dependencies.pairing] +version = "0.11" +features = ["u128-support"] +``` + +## Security Warnings + +This library does not make any guarantees about constant-time operations, memory access patterns, or resistance to side-channel attacks. + ## License Licensed under either of