Documentation updates and prepare for relase.
This commit is contained in:
13
README.md
13
README.md
@@ -1,4 +1,4 @@
|
||||
# emsha
|
||||
# emsha: EMbedded Secure HAshing
|
||||
|
||||
[](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
|
||||
|
||||
Reference in New Issue
Block a user