From 003edc8b259f48c2ad260b44d2139720b799ab04 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 01:31:42 +0200 Subject: [PATCH 1/3] Fix README placeholders --- README.md | 66 ++++--------------------------------------------------- 1 file changed, 4 insertions(+), 62 deletions(-) diff --git a/README.md b/README.md index 98e9e64..ad0cb10 100644 --- a/README.md +++ b/README.md @@ -1,69 +1,11 @@ # GZip -A module that handled GZip compression and decompression. +GZip is intended to be a PowerShell module for handling GZip archives. -## Prerequisites +## Status -This uses the following external resources: -- The [PSModule framework](https://github.com/PSModule) for building, testing and publishing the module. - -## Installation - -To install the module from the PowerShell Gallery, you can use the following command: - -```powershell -Install-PSResource -Name GZip -Import-Module -Name GZip -``` - -## Usage - -Here is a list of example that are typical use cases for the module. - -### Example 1: Greet an entity - -Provide examples for typical commands that a user would like to do with the module. - -```powershell -Greet-Entity -Name 'World' -Hello, World! -``` - -### Example 2 - -Provide examples for typical commands that a user would like to do with the module. - -```powershell -Import-Module -Name PSModuleTemplate -``` - -### 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'. - -## Documentation - -Link to further documentation if available, or describe where in the repository users can find more detailed documentation about -the module's functions and features. +This repository is currently a placeholder. The module source still contains scaffold code, so there are no supported commands or usage examples to document yet. ## 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. - -## Acknowledgements - -Here is a list of people and projects that helped this project in some way. +Issues and pull requests are welcome when implementation work begins. From 5835452eab960938ee66988b67159781054ba0c5 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 08:27:01 +0200 Subject: [PATCH 2/3] Standardize README landing page --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index ad0cb10..52f507a 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ GZip is intended to be a PowerShell module for handling GZip archives. This repository is currently a placeholder. The module source still contains scaffold code, so there are no supported commands or usage examples to document yet. +## Documentation + +When this module is implemented, command details should live in PowerShell help and generated documentation rather than being duplicated in this README. + ## Contributing Issues and pull requests are welcome when implementation work begins. From 8dcac04e8676edae82573fb8b78e4b93dfa142cf Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 10:41:27 +0200 Subject: [PATCH 3/3] Address Copilot README review --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 52f507a..a5620a8 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # GZip -GZip is intended to be a PowerShell module for handling GZip archives. +GZip is intended to be a PowerShell module for compressing and decompressing gzip files. ## Status -This repository is currently a placeholder. The module source still contains scaffold code, so there are no supported commands or usage examples to document yet. +This repository is currently a placeholder. The module source still contains template scaffold commands used by tests, but no supported gzip-focused commands or usage examples are available yet. ## Documentation