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

Add README.md for each packages #102

Merged
merged 10 commits into from
Feb 24, 2024

Conversation

lukasjhan
Copy link
Member

It closes #87

This PR contains

  • meta tags for homepages
  • README.md for each packages
  • Revise badges and descriptions in README
  • Fix typo broswer-crypto => browser-crypto

Copy link

codecov bot commented Feb 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.07%. Comparing base (e0157cf) to head (900158b).
Report is 2 commits behind head on next.

Additional details and impacted files
@@           Coverage Diff           @@
##             next     #102   +/-   ##
=======================================
  Coverage   92.07%   92.07%           
=======================================
  Files          21       21           
  Lines        1514     1514           
  Branches      229      229           
=======================================
  Hits         1394     1394           
  Misses        113      113           
  Partials        7        7           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@@ -1,6 +1,6 @@
![Coverage](https://img.shields.io/badge/coverage-93%25-green)
![Coverage](https://img.shields.io/codecov/c/github/openwallet-foundation-labs/sd-jwt-js)
Copy link
Member Author

Choose a reason for hiding this comment

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

I added codecov project :)

Comment on lines +6 to +17
<meta name="description" content="SD JWT is a TypeScript library implementing the IETF SD-JWT specification for selective disclosure of JWT claims, enhancing privacy and security in digital communications." />
<meta name="keywords" content="SD JWT, TypeScript, JWT, JSON Web Token, selective disclosure, IETF, authentication, Node.js, React Native, security, privacy, data transmission" />
<meta name="author" content="OpenWallet Foundation" />
<meta property="og:title" content="SD JWT - TypeScript JWT Library" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://sdjwt.js.org" />
<meta property="og:image" content="https://avatars.githubusercontent.com/u/114502864?s=200&v=4" />
<meta property="og:description" content="SD JWT is a TypeScript library implementing the IETF SD-JWT specification for selective disclosure of JWT claims, enhancing privacy and security in digital communications." />
<meta property="og:site_name" content="SD JWT - TypeScript JWT Library" />
<meta property="og:locale" content="en_US" />
<link rel="canonical" href="https://sdjwt.js.org" />
<title>SD JWT - TypeScript SD JWT Library</title>
Copy link
Member Author

Choose a reason for hiding this comment

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

I added meta tags for SEO. Hopefully it gets better

Copy link
Contributor

@cre8 cre8 left a comment

Choose a reason for hiding this comment

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

just small notes, but all in all it looks good.

README.md Show resolved Hide resolved
packages/browser-crypto/README.md Show resolved Hide resolved
@@ -0,0 +1,35 @@
![Coverage](https://img.shields.io/codecov/c/github/openwallet-foundation-labs/sd-jwt-js)
Copy link
Contributor

Choose a reason for hiding this comment

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

we should keep in mind that our coverage rate is calculated for the whole project, not for every library by itself.

I don't see the need to present it for each individual, just to mention it ;)

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, good point. Maybe we should put the codecov link of our project. To see the details
What do you think about it?

Copy link
Contributor

Choose a reason for hiding this comment

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

I would remove anything from the packages readme that does not belong there, e.g. the code coverage of the project.

Copy link
Member Author

Choose a reason for hiding this comment

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

Okay :) done in 900158b

@lukasjhan
Copy link
Member Author

@cre8 I updated some changes. :)

README.md Show resolved Hide resolved
@lukasjhan lukasjhan merged commit 0f4cd5d into openwallet-foundation-labs:next Feb 24, 2024
8 checks passed
cre8 pushed a commit to cre8/sd-jwt-js that referenced this pull request Mar 8, 2024
Signed-off-by: Lukas <[email protected]>
Signed-off-by: Lukas.J.Han <[email protected]>
Signed-off-by: Mirko Mollik <[email protected]>
cre8 pushed a commit that referenced this pull request Mar 8, 2024
Signed-off-by: Lukas <[email protected]>
Signed-off-by: Lukas.J.Han <[email protected]>
Signed-off-by: Mirko Mollik <[email protected]>
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.

Revise READMEs
2 participants