Skip to content

Commit

Permalink
Add references to explain algorithms in README
Browse files Browse the repository at this point in the history
  • Loading branch information
tniessen committed Nov 26, 2024
1 parent d56fb73 commit 196b111
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# PQClean for Node.js, Deno, and more

This package provides Node.js bindings for [PQClean][], a collection of
post-quantum cryptography algorithm implementations, including 16 key
encapsulation mechanisms and 19 digital signature algorithms.
[post-quantum cryptography][] algorithm implementations, including 16
[key encapsulation mechanisms][] and 19 [digital signature algorithms][].

In addition to the native addon for Node.js, this package also provides an
implementation for Deno and other JavaScript runtimes, such as browsers, based
Expand Down Expand Up @@ -60,4 +60,7 @@ This project is distributed under the MIT license. Please check
implementations.

[PQClean]: https://github.com/PQClean/PQClean
[digital signature algorithms]: https://en.wikipedia.org/wiki/Digital_signature
[key encapsulation mechanisms]: https://en.wikipedia.org/wiki/Key_encapsulation_mechanism
[post-quantum cryptography]: https://en.wikipedia.org/wiki/Post-quantum_cryptography
[nodejs/node#43630]: https://github.com/nodejs/node/issues/43630

0 comments on commit 196b111

Please sign in to comment.