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

Cleanup code snippets in README.

Browse source
This commit is contained in:
Isis Lovecruft 2017-12-02 03:19:19 +00:00
parent 6ed4e24ddd
commit 27ba42a6eb
Failed to extract signature
1 changed files with 16 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -44,22 +44,34 @@ Extensive documentation is available [here](https://docs.rs/curve25519-dalek).
To install, add the following to the dependencies section of your project's To install, add the following to the dependencies section of your project's
`Cargo.toml`: `Cargo.toml`:
curve25519-dalek = "^0.13" ```toml
curve25519-dalek = "^0.13"
```
Then, in your library or executable source, add: Then, in your library or executable source, add:
extern crate curve25519_dalek extern crate curve25519_dalek;
## Features
On nightly Rust, using the `nightly` feature enables a radix-51 field On nightly Rust, using the `nightly` feature enables a radix-51 field
arithmetic implementation using `u128`s, which is approximately twice as arithmetic implementation using `u128`s, which is approximately twice as
fast. fast. It will also enable additional developer documentation when
compiling via `make doc-internal`.
By default, the benchmarks are not compiled without the `bench`
feature. To run the benchmarks, do:
```sh
cargo bench --features="bench"
```
## TODO ## TODO
We intend to stabilise the following before curve25519-dalek-1.0.0: We intend to stabilise the following before curve25519-dalek-1.0.0:
* Implement hashing to a point on the curve (Elligator). * Implement hashing to a point on the curve (Elligator).
* Finish Ristretto (Decaf for curve25519) implementation. * Finish Ristretto documentation.
## Contributing ## Contributing