diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index c4f36acf..f2a18f0c 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -34,3 +34,8 @@ jobs: npm i npm test -- --coverage=true npm run build + + - name: Upload coverage reports to Codecov + uses: codecov/codecov-action@v3 + env: + CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} \ No newline at end of file diff --git a/README.md b/README.md index 4454dd86..afe3cfb4 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ Project Name: signify-ts [![TypeScript](https://badges.frapsoft.com/typescript/code/typescript.png?v=101)](https://github.com/ellerbrock/typescript-badges/) +[![Tests](https://github.com/WebOfTrust/signify-ts/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/WebOfTrust/signify-ts/actions/workflows/main.yml) ## Signify - KERI Signing at the Edge @@ -15,12 +16,12 @@ Of the five functions in a KERI agent, 5. Event Validation Signify-TS splits off two, key generation and event signing into a TypeScript library to provide "signing at the edge". -It accomplishes this by using libsodium to generate ed25510 key pairs for signing and x25519 key pairs for encrypting the +It accomplishes this by using [libsodium](https://doc.libsodium.org/) to generate ed25510 key pairs for signing and x25519 key pairs for encrypting the private keys, next public keys and salts used to generate the private keys. The encrypted private key and salts are then stored on a -remote cloud agent the never has access to the decryption keys. New key pair sets (current and next) will be generated -for inception and rotation events with only the public keys and blake3 hash of next keys made available to the agent. +remote cloud agent that never has access to the decryption keys. New key pair sets (current and next) will be generated +for inception and rotation events with only the public keys and blake3 hash of the next keys made available to the agent. -The communication protocol between a Signify client and KERI agent will encode all cryptographic primitives as CESR base64 +The communication protocol between a Signify client and [KERI](https://github.com/WebOfTrust/keri) agent will encode all cryptographic primitives as CESR base64 encoded strings for the initial implementation. Support for binary CESR can be added in the future.