Dustin-Ray / capyCRYPT

An experimental high-performance cryptosystem.
MIT License
12 stars 1 forks source link

docs: update curve usage examples #39

Closed Dustin-Ray closed 11 months ago

Dustin-Ray commented 11 months ago

since #29 is merged and happily live on main, we made a few small modifications to how the curve operations are used. The usage examples in the readme as well as in ops.rs will need to be updated accordingly.

Specifically, calls to curve instantiation traits no longer require a curve-type enum, because we only support one curve now. The readme needs to be adjusted to account for this. See e448_tests.rs for examples on how to use the curve.

In ops.rs, the examples have been removed completely in order to force the doctests to pass. After updating the readme, we can probably just copy those examples directly into ops.