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

[Marius Storhaug (MariusStorhaug)]

The README now works as a concise landing page for the module. It leads with what the module does, how to install it, a short usage showcase built from real commands, and where to find the full generated documentation.

What changed

• Overview — a one-paragraph description of what Ast does.
• Installation — uses Install-PSResource, the current PowerShell Gallery client.
• Usage — a short showcase of the most common commands (Get-AstFunction, Get-AstFunctionName, Get-AstCommand) run against a script. This is a getting-started showcase, not a full command reference: exhaustive per-command details stay in PowerShell help and the generated documentation so the landing page does not duplicate them.
• Documentation — links to psmodule.io/Ast and shows Get-Command / Get-Help discovery using a real command name.
• Related tools — keeps the pointer to the external ShowPSAst AST viewer.
• Removed the ## Contributing section.

Technical details

• Updates README.md only.
• Aligns this repository with the standard module landing-page format used across PSModule.

[Copilot]

Pull request overview

Standardizes the repository README.md to function as a lightweight landing page, moving detailed usage guidance to PowerShell help and the published module documentation site.

Changes:

• Replaces the long usage/examples section with a link to published documentation.
• Updates the README to direct users to Get-Command / Get-Help for command discovery and examples.
• Simplifies the contributing section to a short pointer to the issue tracker.

Comments suppressed due to low confidence (1)

README.md:28

• The file ends with a line that contains trailing whitespace (spaces on an otherwise blank line). This can cause noisy diffs and fails some markdown/whitespace linters; please remove the trailing spaces and (optionally) the extra blank line at EOF.

Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements.

---

💡 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	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 ✅
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.

[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

[Copilot]

Pull request overview

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