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

[Marius Storhaug (MariusStorhaug)]

The Sodium README is now a concise landing page that leads with what the module does and how to use it.

• Usage showcase restored — end-to-end examples for generating a key pair (New-SodiumKeyPair), encrypting with a public key (ConvertTo-SodiumSealedBox), and decrypting a sealed box (ConvertFrom-SodiumSealedBox).
• Attribution restored — the ## Acknowledgements section crediting the upstream libsodium library is back (required by the standard).
• Prerequisites restored — libsodium, cross-platform PowerShell 7.4+ (the module ships a net8.0 binary), and the Windows Visual C++ Redistributable note.
• Installation uses Install-PSResource.
• Documentation links to psmodule.io/Sodium with a copy-paste-friendly discovery snippet.
• Removed the ## Contributing section (repository governance files are handled by a separate rollout).

Documentation only — no source or functional changes.

[Copilot]

Pull request overview

Standardizes the repository README.md into a lightweight landing page for the Sodium PowerShell module, moving detailed usage/examples out of the README and pointing users to generated documentation and PowerShell help.

Changes:

• Replaces the long-form module description and examples with a short overview and install snippet.
• Adds a documentation link and directs users to Get-Command / Get-Help for usage details.
• Simplifies the contributing section into a short “issues/PRs welcome” statement.

---

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

[github-actions]

Super-linter summary

Language	Validation result
CHECKOV	Pass ✅
CSHARP	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

[github-actions]

Super-linter summary

Language	Validation result
CHECKOV	Pass ✅
CSHARP	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

[Copilot]

Pull request overview

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

[Copilot]

Pull request overview

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

[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 ✅
CSHARP	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

[Copilot]

Pull request overview

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

[github-actions]

Super-linter summary

Language	Validation result
CHECKOV	Pass ✅
CSHARP	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

[Copilot]

Pull request overview

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