Update README.md with simple example and ready() #291
Conversation
Added simple code example to get started and a note about calling the ready() function for the library to be usable.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #291 +/- ##
=======================================
Coverage 83.59% 83.59%
=======================================
Files 48 48
Lines 4225 4225
Branches 1029 1055 +26
=======================================
Hits 3532 3532
+ Misses 689 663 -26
- Partials 4 30 +26 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
README.md
Outdated
|
|
||
| await ready(); | ||
|
|
||
| const bran = '0'.repeat(21); |
There was a problem hiding this comment.
We should probably use randomPasscode here, just so new users are aware Signify can generate it instead of external
There was a problem hiding this comment.
Thanks. Why is it a shared secret with KERIA though? It's generated locally with libsodium
There was a problem hiding this comment.
@iFergal isn't this meant to be stored OOB by the user to access/manipulate state on KERIA?
There was a problem hiding this comment.
Yeah since Signify is stateless but it's never shared with KERIA. It's just used to derive the keys locally, and those public keys/events etc are shared with KERIA.
There was a problem hiding this comment.
@iFergal yeah you're right, I'll remove the comment.
randomPasscode added to example to make new users aware.
removed erroneous comment.
Happened to get https://github.com/WebOfTrust/signify-ts/actions/runs/11895128350/job/33143979521?pr=291 when updating README in WebOfTrust#291. This PR fixes that vulnerability in cross-spawn so that test should pass now.
|
Added #292 to fix failing test action in this PR. |
Happened to get https://github.com/WebOfTrust/signify-ts/actions/runs/11895128350/job/33143979521?pr=291 when updating README in #291. This PR fixes that vulnerability in cross-spawn so that test should pass now.
Added simple code example to get started and a note about calling the ready() function for the library to be usable.