This is an automated email from the ASF dual-hosted git repository.
gstein pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/steve.git
The following commit(s) were added to refs/heads/trunk by this push:
new bb843c9 codecov test provides API demo
bb843c9 is described below
commit bb843c96b75a62d89c80b52f96e3882f31ef9b56
Author: Greg Stein <[email protected]>
AuthorDate: Sun Jun 5 20:07:49 2022 -0400
codecov test provides API demo
---
v3/README.md | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/v3/README.md b/v3/README.md
index 8428d9f..d3107d7 100644
--- a/v3/README.md
+++ b/v3/README.md
@@ -88,7 +88,7 @@ Issue-data := TBD
BLOCK := Election-data + sorted(Issue-Data)
OpenedKey := Hash(BLOCK, Salt(each-election))
-Personss := Map<PersonID, Salt(each-person)>
+Persons := Map<PersonID, Salt(each-person)>
PersonToken := Hash(OpenedKey + PersonID, Salt(each-person))
Issues := Map<IssueID, Salt(each-issue)>
@@ -158,6 +158,12 @@ to the STV algorithm.
Note that the tally process does not require unmasking the Person.
+### API Documentation
+
+This is _TBD_
+
+A basic example of using the API is available via the
+[code coverage testing script](test/check_coverage.py).
[^fernet]: https://cryptography.io/en/latest/fernet/