From 4a0f6710a7cb831b9e2cb0cdf731f24099fda64a Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 01:31:41 +0200 Subject: [PATCH 1/3] Fix README placeholders --- README.md | 66 +++++-------------------------------------------------- 1 file changed, 5 insertions(+), 61 deletions(-) diff --git a/README.md b/README.md index a52e2f3..b094b19 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,11 @@ -# PSModuleTemplate +# GraphQL -Add a short description about the module and the project. +GraphQL is intended to be a PowerShell module for simplifying work with GraphQL APIs. -## Prerequisites +## Status -List any prerequisites needed to use the module, such as PowerShell versions, additional modules, or permissions. - -## Installation - -Provide step-by-step instructions on how to install the module, including any InstallModule commands or manual installation steps. - -```powershell -Install-Module -Name YourModuleName -``` - -## Usage - -Here is a list of example that are typical use cases for the module. -This section should provide a good overview of the module's capabilities. - -### Example 1 - -Provide examples for typical commands that a user would like to do with the module. - -```powershell -Import-Module -Name PSModuleTemplate -``` - -### 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 27c91fd2f9e16a7578d4df8092c370b55c7fa622 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 08:26:58 +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 b094b19..f8be5fd 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ GraphQL is intended to be a PowerShell module for simplifying work with GraphQL 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 52c2f1a955da48d336f14f2552c83bc0df0b517b Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 10:45:38 +0200 Subject: [PATCH 3/3] Address Copilot README review --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f8be5fd..d24d06d 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ GraphQL is intended to be a PowerShell module for simplifying work with GraphQL ## 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 scaffold code, so there are no supported GraphQL-focused commands or usage examples to document yet. ## Documentation