Skip to content

Commit

Permalink
small doc and readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
franziskuskiefer authored Jul 12, 2023
1 parent ad40e53 commit cb2a781
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 5 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# The Cryspen HACL Packages

![][status]

This repository contains ready-to-use crypto packages developed by [Cryspen] on top of [HACL*].
In particular, it contains a portable C crypto library that selects optimized implementations for each platform,
as well as Rust, OCaml, and JavaScript bindings for this library.
Expand Down Expand Up @@ -147,6 +145,7 @@ packages.
| Signature | Ed25519 | Portable |
| Signature | ECDSA P-256r1 | Portable |
| Signature | ECDSA P-256k1 | Portable |
| Signature | RSA-PSS | Portable |
| Hash | SHA2-224 | Portable \| SHAEXT |
| Hash | SHA2-256 | Portable \| SHAEXT |
| Hash | SHA2-384 | Portable |
Expand Down
3 changes: 3 additions & 0 deletions docs/book/src/hacl-ocaml/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ See [Changes.md] for changes between the versions.

| Version | Package 📦 | Docs 📚 |
| ------- | ------------- | ------------- |
| 0.7.1 | [opam v0.7.1] | [Docs v0.7.1] |
| 0.7.0 | [opam v0.7.0] | [Docs v0.7.0] |
| 0.6.2 | [opam v0.6.2] | [Docs v0.6.2] |
| 0.6.1 | [opam v0.6.1] | [Docs v0.6.1] |
Expand All @@ -23,8 +24,10 @@ See [Changes.md] for changes between the versions.
[opam v0.6.1]: https://opam.ocaml.org/packages/hacl-star/hacl-star.0.6.1/
[opam v0.6.2]: https://opam.ocaml.org/packages/hacl-star/hacl-star.0.6.2/
[opam v0.7.0]: https://opam.ocaml.org/packages/hacl-star/hacl-star.0.7.0/
[opam v0.7.1]: https://opam.ocaml.org/packages/hacl-star/hacl-star.0.7.1/
[docs v0.5.0]: https://cryspen.com/hacl-packages/ocaml/ocaml-v0.5.0/index.html
[docs v0.6.0]: https://cryspen.com/hacl-packages/ocaml/ocaml-v0.6.0/index.html
[docs v0.6.1]: https://cryspen.com/hacl-packages/ocaml/ocaml-v0.6.1/index.html
[docs v0.6.2]: https://cryspen.com/hacl-packages/ocaml/ocaml-v0.6.2/index.html
[docs v0.7.0]: https://cryspen.com/hacl-packages/ocaml/ocaml-v0.7.0/index.html
[docs v0.7.1]: https://cryspen.com/hacl-packages/ocaml/ocaml-v0.7.1/index.html
16 changes: 14 additions & 2 deletions docs/book/src/news.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,21 @@
A short log of what is happening in the HACL world.
This is not authoritative. Please see the [CHANGELOG] for released changes.

## February 2023
## June 2023

[Git changes](https://github.com/cryspen/hacl-packages/compare/fd902c6431d9a7aec4cb4eba696756f2a2cf32db...cfc2f9274cac3fc4f988edf4a0356ad5d839cbd1)

## May 2023

[Git changes](https://github.com/cryspen/hacl-packages/compare/32648c1fb653b5db2070c3eda7eac200155281df...fd902c6431d9a7aec4cb4eba696756f2a2cf32db)

## April 2023

[Git changes](https://github.com/cryspen/hacl-packages/compare/cc6a47829626e9b4a1dab892b1bde96990fde2b2...32648c1fb653b5db2070c3eda7eac200155281df)

### Releases

[Git changes](https://github.com/cryspen/hacl-packages/compare/cc6a47829626e9b4a1dab892b1bde96990fde2b2...main)
- OCaml 0.7.0

## March 2023

Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Introduction
# HACL Packages

The Cryspen HACL packages is a collection of cryptographic libraries developed
by Cryspen on top of [HACL*].
Expand Down

0 comments on commit cb2a781

Please sign in to comment.