Add security warnings and some instructions to README.md.

This commit is contained in:
Sean Bowe 2017-09-28 13:32:34 -06:00
parent 93e2a132b5
commit 4aa51bd3d4
No known key found for this signature in database
GPG Key ID: 95684257D8F8B031
2 changed files with 16 additions and 0 deletions

View File

@ -1,5 +1,7 @@
[package]
name = "pairing"
# Remember to change version string in README.md.
version = "0.11.0"
authors = ["Sean Bowe <ewillbefull@gmail.com>"]
license = "MIT/Apache-2.0"

View File

@ -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