Documentation updates and prepare for relase.

This commit is contained in:
2023-10-22 02:43:19 -07:00
parent a682c339bf
commit e05aa1295c
6 changed files with 18 additions and 261 deletions

View File

@@ -1,4 +1,4 @@
# emsha
# emsha: EMbedded Secure HAshing
[![CircleCI](https://dl.circleci.com/status-badge/img/gh/shimmering-clarity/emsha/tree/master.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/shimmering-clarity/emsha/tree/master)
@@ -39,6 +39,17 @@ There are two cache variables that might be useful:
- `SET_EMSHA_NO_SELFTEST` disables the internal self-tests, which can
reclaim some additional program space.
### Synopsis
The Hash pure virtual class defines a basic interface for programs:
- Hash::Reset will clear an instance of a Hash class.
- Hash::Update writes data into the Hash.
- Hash::Finalize will finish the Hash function and write the results
out.
There are two implementations provided for Hash: SHA256 and HMAC.
### Documentation
Documentation is currently done with Doxygen; documentation is