mirror of
https://github.com/saymrwulf/curve25519-dalek-source.git
synced 2026-09-04 20:24:10 +00:00
Add warning and documentation sections to the README.
This commit is contained in:
parent
2a74e28587
commit
d5f27c471c
1 changed files with 13 additions and 0 deletions
13
REAME.md
13
REAME.md
|
|
@ -36,6 +36,19 @@ faster, one fifth faster, and one eighth faster respectively. Of course, this
|
|||
is just my machine, and these results—nowhere near rigorous—should be taken
|
||||
with a fistful of salt.
|
||||
|
||||
## Warning
|
||||
|
||||
[Our elliptic curve library](https://github.com/isislovecruft/curve25519-dalek)
|
||||
(which this code uses) has **not** yet received sufficient peer review by
|
||||
other qualified cryptographers to be considered in any way, shape, or form,
|
||||
safe.
|
||||
|
||||
**USE AT YOUR OWN RISK**
|
||||
|
||||
# Documentation
|
||||
|
||||
Documentation is available [here](https://docs.rs/ed25519-dalek).
|
||||
|
||||
# Installation
|
||||
|
||||
To install, add the following to the dependencies section of your project's
|
||||
|
|
|
|||
Loading…
Reference in a new issue