Skip to content

📖 [Docs]: README pages now use the standard module landing-page format#32

Open
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
mainfrom
docs/standardize-readme
Open

📖 [Docs]: README pages now use the standard module landing-page format#32
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
mainfrom
docs/standardize-readme

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Jul 6, 2026

Copy link
Copy Markdown
Member

The Jwt README is now a concise landing page. Users get a short overview, one-line install, a
copy-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

  • Usage showcase — realistic examples for New-JwtTest-JwtGet-JwtPayload (create an
    HS256 token, validate it, decode the payload).
  • Security note — a caution that the none algorithm produces an unsigned token and should not be
    used for authentication or authorization.
  • Documentation — points to psmodule.io/Jwt plus a real discovery
    snippet (Get-Command -Module Jwt, Get-Help -Name New-Jwt -Examples).
  • Removed the redundant ## Commands inventory (duplicated generated help) and the
    ## Contributing section.

Technical details

  • Updates README.md only.
  • Aligns the README with the PSModule module landing-page standard.

Copilot AI review requested due to automatic review settings July 6, 2026 06:30

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

@MariusStorhaug Marius Storhaug (MariusStorhaug) changed the title Docs: standardize README 📖 [Docs]: README pages now use the standard module landing-page format Jul 6, 2026
Copilot AI review requested due to automatic review settings July 12, 2026 10:43
@MariusStorhaug Marius Storhaug (MariusStorhaug) added documentation Improvements or additions to documentation NoRelease Documentation, maintenance, CI/CD — no version bump labels Jul 12, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment thread README.md

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

Comment thread README.md
Comment on lines +3 to +4
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.
Comment thread README.md
```powershell
Get-JwtHeader -jwt $jwt
Get-JwtPayload -jwt $jwt
$jwt | Get-JwtPayload
Copilot AI review requested due to automatic review settings July 12, 2026 10:47

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@github-actions

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation NoRelease Documentation, maintenance, CI/CD — no version bump

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants