Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update readme packages #1206

Conversation

karimStekelenburg
Copy link
Contributor

I noticed only the core, node and react-native packages were listed in the README.md. I'm not sure if this was done on purpose or just forgotten. I've added the bbs-signatures, action-menu, question-answer, and tenants modules and updated the tenants roadmap state from 🚧 to ✅. Please comment/reject if this is incorrect.

Also, I've just appended the missing modules to the table for now. I'm not sure about the ordering of these modules/table rows. One approach is to order them alphabetically, but my personal preference is to order them by relevance.

Example:

  1. core -- as you'll always need it
  2. node & react-native (in random order) -- as you'll always need one of the two
  3. Other modules -- as they really depend on your use case.

Signed-off-by: Karim Stekelenburg karim@animo.id

Signed-off-by: Karim Stekelenburg <karim@animo.id>
@karimStekelenburg karimStekelenburg requested a review from a team as a code owner January 11, 2023 21:56
Copy link
Contributor

@berendsliedrecht berendsliedrecht left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it was just forgotten. Good catch :).

Also, I think the order you did is correct and just keep adding at the bottom.

Copy link
Contributor

@genaris genaris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few errors I noticed when looking at the rendered version.

Would be good also to review all the RFCs we support (e.g. Present Proof V2 is not yet there) and add them to the list but I think it could be part of a separate PR.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
karimStekelenburg and others added 3 commits January 11, 2023 23:26
Co-authored-by: Ariel Gentile <gentilester@gmail.com>
Signed-off-by: Karim Stekelenburg <karim@animo.id>
Co-authored-by: Ariel Gentile <gentilester@gmail.com>
Signed-off-by: Karim Stekelenburg <karim@animo.id>
Signed-off-by: Karim Stekelenburg <karim@animo.id>
@karimStekelenburg karimStekelenburg enabled auto-merge (squash) January 11, 2023 22:37
@codecov-commenter
Copy link

codecov-commenter commented Jan 11, 2023

Codecov Report

Merging #1206 (8f21aeb) into main (da7abde) will decrease coverage by 1.33%.
The diff coverage is 57.31%.

@@            Coverage Diff             @@
##             main    #1206      +/-   ##
==========================================
- Coverage   88.91%   87.57%   -1.34%     
==========================================
  Files         708      726      +18     
  Lines       16614    17350     +736     
  Branches     2809     2972     +163     
==========================================
+ Hits        14773    15195     +422     
- Misses       1734     2013     +279     
- Partials      107      142      +35     
Impacted Files Coverage Δ
packages/core/src/utils/validators.ts 67.85% <ø> (ø)
packages/indy-sdk/src/ledger/IndySdkPool.ts 17.64% <17.64%> (ø)
packages/indy-sdk/src/wallet/IndySdkWallet.ts 37.59% <37.59%> (ø)
packages/indy-sdk/src/error/IndySdkError.ts 40.00% <40.00%> (ø)
packages/indy-sdk/src/anoncreds/utils/transform.ts 50.00% <50.00%> (ø)
...e/src/modules/indy/services/IndyVerifierService.ts 77.41% <57.14%> (ø)
packages/indy-sdk/src/error/indyError.ts 66.66% <66.66%> (ø)
packages/indy-sdk/src/utils/assertIndySdkWallet.ts 66.66% <66.66%> (ø)
packages/indy-sdk/src/ledger/IndySdkPoolService.ts 70.71% <70.71%> (ø)
packages/indy-sdk/src/utils/did.ts 82.60% <82.60%> (ø)
... and 14 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants