Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pdimov committed Oct 18, 2024
1 parent 6910f0c commit eabfa98
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ It also contains implementations of several popular hashing algorithms:
* [SipHash](https://131002.net/siphash/)
* [MD5](https://tools.ietf.org/html/rfc1321)
* [SHA-1](https://tools.ietf.org/html/rfc3174)
* [HMAC-MD5 and HMAC-SHA1](https://tools.ietf.org/html/rfc2104)
* [SHA-2](https://tools.ietf.org/html/rfc6234)
* [HMAC-MD5, HMAC-SHA1, HMAC-SHA2](https://tools.ietf.org/html/rfc2104)

The hashing algorithms conform to the following concept:

Expand Down Expand Up @@ -53,7 +54,6 @@ None yet.
## Planned Additions

* Documentation (obv.)
* SHA2-256, 384, 512
* Support for endian-independent hashing
* A `std::hash`-compatible adaptor
* A type-erased `hash_function`
Expand Down
3 changes: 2 additions & 1 deletion doc/hash2/overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ The following popular hashing algorithms are provided:
* https://131002.net/siphash/[SipHash]
* https://tools.ietf.org/html/rfc1321[MD5]
* https://tools.ietf.org/html/rfc3174[SHA-1]
* https://tools.ietf.org/html/rfc2104[HMAC-MD5 and HMAC-SHA1]
* https://tools.ietf.org/html/rfc6234[SHA-2]
* https://tools.ietf.org/html/rfc2104[HMAC-MD5, HMAC-SHA1, HMAC-SHA2]
but it's also possible for users to write their own; as long as the
hash algorithm conforms to the concept, `hash_append` will work with it,
Expand Down

0 comments on commit eabfa98

Please sign in to comment.