Add security warnings and some instructions to README.md.
This commit is contained in:
parent
93e2a132b5
commit
4aa51bd3d4
|
@ -1,5 +1,7 @@
|
||||||
[package]
|
[package]
|
||||||
name = "pairing"
|
name = "pairing"
|
||||||
|
|
||||||
|
# Remember to change version string in README.md.
|
||||||
version = "0.11.0"
|
version = "0.11.0"
|
||||||
authors = ["Sean Bowe <ewillbefull@gmail.com>"]
|
authors = ["Sean Bowe <ewillbefull@gmail.com>"]
|
||||||
license = "MIT/Apache-2.0"
|
license = "MIT/Apache-2.0"
|
||||||
|
|
14
README.md
14
README.md
|
@ -4,6 +4,20 @@ This is a Rust crate for using pairing-friendly elliptic curves. Currently, only
|
||||||
|
|
||||||
## [Documentation](https://docs.rs/pairing/)
|
## [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
|
## License
|
||||||
|
|
||||||
Licensed under either of
|
Licensed under either of
|
||||||
|
|
Loading…
Reference in New Issue