From 97c45f281af16dc8e0c2087c2d6e0e3e2993ce6b Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Tue, 24 Sep 2019 10:53:52 +0100 Subject: [PATCH] Update READMEs --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bf386dea2..47a25dc68 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,16 @@ # pairing [![Crates.io](https://img.shields.io/crates/v/pairing.svg)](https://crates.io/crates/pairing) # -This is a Rust crate for using pairing-friendly elliptic curves. Currently, only the [BLS12-381](https://z.cash/blog/new-snark-curve.html) construction is implemented. +`pairing` is a crate for using pairing-friendly elliptic curves. + +Currently, only the [BLS12-381](https://z.cash/blog/new-snark-curve.html) +construction is implemented. + +## Roadmap + +`pairing` is being refactored into a generic library for working with +pairing-friendly curves. After the refactor, `pairing` will provide basic traits +for pairing-friendly elliptic curve constructions, while specific curves will be +in separate crates. ## [Documentation](https://docs.rs/pairing/) @@ -8,13 +18,15 @@ Bring the `pairing` crate into your project just as you normally would. ## Security Warnings -This library does not make any guarantees about constant-time operations, memory access patterns, or resistance to side-channel attacks. +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 - * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) + * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or + http://www.apache.org/licenses/LICENSE-2.0) * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) at your option.