Skip to content

Commit 0753ca7

Browse files
Fix README placeholders
1 parent c385cfd commit 0753ca7

1 file changed

Lines changed: 24 additions & 40 deletions

File tree

README.md

Lines changed: 24 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,53 @@
1-
# {{ NAME }}
1+
# Object
22

3-
{{ DESCRIPTION }}
3+
Object is a PowerShell module for working with PowerShell objects.
44

55
## Prerequisites
66

7-
This uses the following external resources:
8-
- The [PSModule framework](https://github.com/PSModule) for building, testing and publishing the module.
7+
- PowerShell with `Microsoft.PowerShell.PSResourceGet` available for `Install-PSResource`.
8+
- The [PSModule framework](https://github.com/PSModule) is used for building, testing, and publishing the module.
99

1010
## Installation
1111

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

1414
```powershell
15-
Install-PSResource -Name {{ NAME }}
16-
Import-Module -Name {{ NAME }}
15+
Install-PSResource -Name Object
16+
Import-Module -Name Object
1717
```
1818

19-
## Usage
19+
## Commands
2020

21-
Here is a list of example that are typical use cases for the module.
21+
- `Remove-Member` removes one or more properties from objects passed through the pipeline. Use `-PassThru` to return the modified object.
2222

23-
### Example 1: Greet an entity
23+
## Usage
2424

25-
Provide examples for typical commands that a user would like to do with the module.
25+
Remove a property and return the modified object:
2626

2727
```powershell
28-
Greet-Entity -Name 'World'
29-
Hello, World!
30-
```
28+
$object = [PSCustomObject]@{
29+
Name = 'Ada'
30+
Age = 37
31+
City = 'London'
32+
}
3133
32-
### Example 2
34+
$object | Remove-Member -Name Age -PassThru
35+
```
3336

34-
Provide examples for typical commands that a user would like to do with the module.
37+
Remove multiple properties:
3538

3639
```powershell
37-
Import-Module -Name PSModuleTemplate
40+
$object | Remove-Member -Name Age, City -PassThru
3841
```
3942

40-
### Find more examples
41-
42-
To find more examples of how to use the module, please refer to the [examples](examples) folder.
43+
## Examples
4344

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'.
45+
More usage examples are available in the [examples](examples) folder.
4646

4747
## Documentation
4848

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.
49+
Command documentation is published at [psmodule.io/Object](https://psmodule.io/Object/).
5150

5251
## Contributing
5352

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.
53+
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)