Skip to content

Commit 801301c

Browse files
Standardize README landing page
1 parent 59fc671 commit 801301c

1 file changed

Lines changed: 7 additions & 49 deletions

File tree

README.md

Lines changed: 7 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -2,68 +2,26 @@
22

33
{{ DESCRIPTION }}
44

5-
## Prerequisites
6-
7-
This uses the following external resources:
8-
- The [PSModule framework](https://github.com/PSModule/Process-PSModule) for building, testing and publishing the module.
9-
105
## Installation
116

12-
To install the module from the PowerShell Gallery, you can use the following command:
7+
Install the module from the PowerShell Gallery:
138

149
```powershell
1510
Install-PSResource -Name {{ NAME }}
1611
Import-Module -Name {{ NAME }}
1712
```
1813

19-
## Usage
20-
21-
Here is a list of example that are typical use cases for the module.
22-
23-
### Example 1: Greet an entity
24-
25-
Provide examples for typical commands that a user would like to do with the module.
26-
27-
```powershell
28-
Greet-Entity -Name 'World'
29-
Hello, World!
30-
```
14+
## Documentation
3115

32-
### Example 2
16+
Documentation is published at [psmodule.io/{{ NAME }}](https://psmodule.io/{{ NAME }}/).
3317

34-
Provide examples for typical commands that a user would like to do with the module.
18+
Use PowerShell help and command discovery for module details:
3519

3620
```powershell
37-
Import-Module -Name PSModuleTemplate
21+
Get-Command -Module {{ NAME }}
22+
Get-Help <CommandName> -Examples
3823
```
3924

40-
### Find more examples
41-
42-
To find more examples of how to use the module, please refer to the [examples](examples) folder.
43-
44-
Alternatively, you can use the Get-Command -Module 'This module' to find more commands that are available in the module.
45-
To find examples of each of the commands you can use Get-Help -Examples 'CommandName'.
46-
47-
## Documentation
48-
49-
Link to further documentation if available, or describe where in the repository users can find more detailed documentation about
50-
the module's functions and features.
51-
5225
## Contributing
5326

54-
Coder or not, you can contribute to the project! We welcome all contributions.
55-
56-
### For Users
57-
58-
If you don't code, you still sit on valuable information that can make this project even better. If you experience that the
59-
product does unexpected things, throw errors or is missing functionality, you can help by submitting bugs and feature requests.
60-
Please see the issues tab on this project and submit a new issue that matches your needs.
61-
62-
### For Developers
63-
64-
If you do code, we'd love to have your contributions. Please read the [Contribution guidelines](CONTRIBUTING.md) for more information.
65-
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.
66-
67-
## Acknowledgements
68-
69-
Here is a list of people and projects that helped this project in some way.
27+
Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements.

0 commit comments

Comments
 (0)