From 9852fc155b286536ed9990f04879985e8d774e1e Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 08:26:22 +0200 Subject: [PATCH] Standardize README landing page --- README.md | 45 ++++++++------------------------------------- 1 file changed, 8 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 0908883..afeb254 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,27 @@ # Ast -A PowerShell module for using the Abstract Syntax Tree (AST) on any PowerShell code. - -## Prerequisites - -This uses the following external resources: -- The [PSModule framework](https://github.com/PSModule) for building, testing and publishing the module. +Ast is a PowerShell module for using the PowerShell abstract syntax tree to analyze PowerShell code. ## Installation -To install the module from the PowerShell Gallery, you can use the following command: +Install the module from the PowerShell Gallery: ```powershell Install-PSResource -Name Ast Import-Module -Name Ast ``` -## Usage - -Here is a list of example that are typical use cases for the module. +## Documentation -### Example 1: Get the function name from a script +Documentation is published at [psmodule.io/Ast](https://psmodule.io/Ast/). -This example shows how to get the function name from a script. +Use PowerShell help and command discovery for module details: ```powershell -Get-AstFunctionName -Path 'Test-Me.ps1' -Test-Me +Get-Command -Module Ast +Get-Help -Examples ``` -### Find more examples - -To find more examples of how to use the module, please refer to the [examples](examples) folder. - -Alternatively, you can use the Get-Command -Module 'This module' to find more commands that are available in the module. -To find examples of each of the commands you can use Get-Help -Examples 'CommandName'. - ## Contributing -Coder or not, you can contribute to the project! We welcome all contributions. - -### For Users - -If you don't code, you still sit on valuable information that can make this project even better. If you experience that the -product does unexpected things, throw errors or is missing functionality, you can help by submitting bugs and feature requests. -Please see the issues tab on this project and submit a new issue that matches your needs. - -### For Developers - -If you do code, we'd love to have your contributions. Please read the [Contribution guidelines](CONTRIBUTING.md) for more information. -You can either help by picking up an existing issue or submit a new one if you have an idea for a new feature or improvement. - -## Tools - -- [lzybkr/ShowPSAst](https://github.com/lzybkr/ShowPSAst) +Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements.