📖 [Docs]: Rework README into the standard module landing page

[Marius Storhaug (MariusStorhaug)]

What changed

The Base64 README is now a proper module landing page: a concise intro, a one-command Installation section (Install-PSResource), a Usage showcase with three real, runnable examples, and a Documentation section that points to psmodule.io/Base64.

User-facing impact

• Anyone landing on the repo or the published docs immediately sees how to install the module and how to encode, decode, and validate Base64 strings with real commands and expected output.
• Restores the three worked examples that were lost in the initial reformat:
  • Encode: 'Hello World' | ConvertTo-Base64
  • Decode: 'SGVsbG8gV29ybGQ=' | ConvertFrom-Base64
  • Validate: 'SGVsbG8gV29ybGQ=' | Test-Base64
• Fixes the command-discovery snippet to use a real command (Get-Help -Name ConvertTo-Base64 -Examples) instead of the <CommandName> placeholder.

Notes

• Removes the boilerplate ## Contributing section per the module landing-page standard.
• Documentation-only change; no module code affected. Markdown validated with the repo's markdownlint config.

[Copilot]

Pull request overview

Standardizes README.md into a lightweight landing page (per Template-PSModule default) by removing detailed command usage and directing users to PowerShell help and hosted docs instead.

Changes:

• Replaces the long-form README introduction/features/usage sections with a brief module description.
• Moves usage guidance to external documentation and Get-Help/Get-Command discovery.
• Simplifies the contributing section to point users to the issue tracker.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[github-actions]

Super-linter summary

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

Super-linter detected linting errors

For more information, see the GitHub Actions workflow run

Powered by Super-linter

NATURAL_LANGUAGE

/github/workspace/README.md
3:35 ✓ error Incorrect term: “Base64”, use “base64” instead terminology
✖ 1 problem (1 error, 0 warnings, 0 infos)
✓ 1 fixable problem.
Try to run: $ textlint --fix [file]

[Copilot]

Pull request overview

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

[github-actions]

Super-linter summary

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

Super-linter detected linting errors

For more information, see the GitHub Actions workflow run

Powered by Super-linter

NATURAL_LANGUAGE

/github/workspace/README.md
3:63 ✓ error Incorrect term: “Base64”, use “base64” instead terminology
4:114 ✓ error Incorrect term: “Base64”, use “base64” instead terminology
18:33 ✓ error Incorrect term: “Base64”, use “base64” instead terminology
20:37 ✓ error Incorrect term: “Base64”, use “base64” instead terminology
32:23 ✓ error Incorrect term: “Base64”, use “base64” instead terminology
34:11 ✓ error Incorrect term: “Base64”, use “base64” instead terminology
46:25 ✓ error Incorrect term: “Base64”, use “base64” instead terminology
48:48 ✓ error Incorrect term: “Base64”, use “base64” instead terminology
✖ 8 problems (8 errors, 0 warnings, 0 infos)
✓ 8 fixable problems.
Try to run: $ textlint --fix [file]

[Copilot]

Pull request overview

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

[github-actions]

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