Commit graph

24 commits

Author SHA1 Message Date
Henry de Valence
e8615a9326 bump version to 1.1.0 and update CHANGELOG 2020-08-31 12:56:34 -07:00
Henry de Valence
1b01d597ca Bump version to 1.0.0 and update CHANGELOG.md 2020-08-17 19:43:22 -07:00
Henry de Valence
8287798aa1 Update doc examples to remove deprecated code and restore testing.
Closes #59.

The doc examples have code interspersed with text explaining the API.  Because
each doctest executes independently, when these code examples are run as
doctests, they have to include parts of the previous examples with # lines.
These lines are hidden from Rustdoc output and do not appear in the rendered
docs, but they do appear when viewing the README.md on Github.

In order to hide these on Github, the code blocks were made non-executable,
with their content moved to a unit test.  However, this meant that the example
API usage was not tested, and so when the unit test was updated to remove the
deprecated `rand_os`, there was no check that the examples stayed in sync with
the test, causing #59.  To prevent this from reocurring in the future, go back
to executable tests of the API examples.
2020-08-17 18:47:31 -07:00
Tony Arcieri
bdc6412faa README.md: Add "See also" section with link to crypto_box crate
The `crypto_box` crate provides a pure Rust implementation of the
public-key authenticated encryption primitive from NaCl which combines
X25519 + XSalsa20Poly1305 (a.k.a. "Curve25519XSalsa20Poly1305")

This commit adds a link to it case x25519-dalek users are interested in
using it as part of a hybrid cryptosystem.
2020-02-25 12:14:41 -08:00
Henry de Valence
d9c7f2814e Bump version to 0.6.0 and update CHANGELOG. 2019-11-26 14:03:08 -08:00
Isis Lovecruft
ea2f39afa5
Ignore doctests since they were moved to actual tests. 2019-02-27 22:01:43 +00:00
Isis Lovecruft
60f276db72
Fix README examples and doctests. 2019-02-27 20:45:55 +00:00
DebugSteven
ad8dd8430b bump installation version to 0.5 in docs 2019-02-16 18:46:11 -07:00
Henry de Valence
e25c72b476 Update README tests and ensure they're run in Travis. 2019-02-16 10:13:39 -08:00
Isis Lovecruft
95b12934d7
Ignore README doctests for now. 2019-01-16 02:18:22 +00:00
Isis Lovecruft
53ba2f3bcc
Merge remote-tracking branch 'newpavlov/rand_os' into release/0.4.0 2019-01-16 01:29:46 +00:00
Isis Lovecruft
bab903cb65
Bump x25519-dalek version to 0.4.0. 2019-01-12 23:35:03 +00:00
Henry de Valence
b8716bb82b Pull source docs from README 2019-01-10 10:30:30 -08:00
Артём Павлов [Artyom Pavlov]
5dcc1c17da use rand_os instead of rand 2019-01-05 16:17:05 +03:00
DebugSteven
8730bfbba6 move implementation of x25519 into diffie_hellman 2018-12-07 17:07:24 -05:00
DebugSteven
2619200aae docs refactor 2018-12-02 14:31:41 -05:00
DebugSteven
734abac70b wrap MontgomeryPoint in EphemeralPublic, impl From; remove byte fns for EphemeralSecret 2018-12-02 14:23:09 -05:00
DebugSteven
cb18af7c1b update readme & fix benches 2018-11-10 16:17:19 -05:00
Isis Lovecruft
41acc60538
Bump x25519-dalek version to 0.3.0. 2018-07-27 20:19:07 +00:00
Isis Lovecruft
751d28340a
Update a link in the README. 2018-07-27 20:18:51 +00:00
Isis Lovecruft
f76e08deec
Add syntax highlighting to README. 2018-05-15 23:00:27 +00:00
Isis Lovecruft
ba0bf47492
Update links in README to point to new github org. 2018-05-15 23:00:06 +00:00
Isis Lovecruft
2f16d80b26
Bump x25519-dalek version to 0.1.0. 2017-10-09 04:33:16 +00:00
Isis Lovecruft
3702a7c598
Initial commit. 2017-10-09 04:02:40 +00:00