Commit c32b18d
authored
📖 [Docs]: README pages now use the standard module landing-page format (#43)
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](https://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.1 parent 52672a9 commit c32b18d
1 file changed
Lines changed: 27 additions & 29 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
4 | | - | |
5 | | - | |
6 | | - | |
7 | | - | |
8 | | - | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
9 | 6 | | |
10 | 7 | | |
11 | 8 | | |
12 | | - | |
| 9 | + | |
13 | 10 | | |
14 | 11 | | |
15 | 12 | | |
| |||
18 | 15 | | |
19 | 16 | | |
20 | 17 | | |
21 | | - | |
22 | | - | |
23 | | - | |
| 18 | + | |
| 19 | + | |
24 | 20 | | |
25 | | - | |
| 21 | + | |
26 | 22 | | |
27 | 23 | | |
28 | | - | |
29 | | - | |
| 24 | + | |
| 25 | + | |
30 | 26 | | |
31 | 27 | | |
32 | | - | |
| 28 | + | |
33 | 29 | | |
34 | | - | |
35 | | - | |
36 | | - | |
37 | | - | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
38 | 34 | | |
39 | | - | |
| 35 | + | |
40 | 36 | | |
41 | | - | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
42 | 40 | | |
43 | | - | |
| 41 | + | |
44 | 42 | | |
45 | | - | |
46 | | - | |
47 | | - | |
| 43 | + | |
48 | 44 | | |
49 | | - | |
| 45 | + | |
50 | 46 | | |
51 | | - | |
52 | | - | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
53 | 51 | | |
54 | | - | |
| 52 | + | |
55 | 53 | | |
56 | | - | |
| 54 | + | |
0 commit comments