Uh oh!
There was an error while loading. Please reload this page.
📖 [Docs]: README pages now use the standard module landing-page format - #32
📖 [Docs]: README pages now use the standard module landing-page format#32Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the repository’s README to serve as a lightweight module landing page, moving detailed command usage guidance to PowerShell help and generated documentation as described in the PR.
Changes:
- Simplified the module description and removed in-README command/usage examples.
- Added a dedicated Documentation section pointing to published docs and PowerShell help usage.
- Streamlined the Contributing section into a single, issue-tracker-focused paragraph.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Uh oh!
There was an error while loading. Please reload this page.
| Jwt is a PowerShell module for creating, decoding, and verifying JSON Web Tokens (JWTs). It supports HS256 | ||
| shared-secret tokens, RS256 certificate-signed tokens, and the `none` algorithm. |
| ```powershell | ||
| Get-JwtHeader -jwt $jwt | ||
| Get-JwtPayload -jwt $jwt | ||
| $jwt | Get-JwtPayload |
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Marius Storhaug (MariusStorhaug)
commented
Jul 26, 2026
Superseded by #26: README content in this PR targets the pre-v2 command surface and is now outdated by the v2 release documentation. |
The
JwtREADME is now a concise landing page. Users get a short overview, one-line install, acopy-paste Usage showcase using the real commands, and links to the published docs — instead of an
exhaustive command inventory that duplicated generated help.
What changed
New-Jwt→Test-Jwt→Get-JwtPayload(create anHS256 token, validate it, decode the payload).
nonealgorithm produces an unsigned token and should not beused for authentication or authorization.
snippet (
Get-Command -Module Jwt,Get-Help -Name New-Jwt -Examples).## Commandsinventory (duplicated generated help) and the## Contributingsection.Technical details
README.mdonly.