Skip to content

📖 [Docs]: README pages now use the standard module landing-page format #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
base: main
Choose a base branch
from
Open

📖 [Docs]: README pages now use the standard module landing-page format #21

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4a0f671
Fix README placeholders
MariusStorhaug Jul 5, 2026
27c91fd
Standardize README landing page
MariusStorhaug Jul 6, 2026
52c2f1a
Address Copilot README review
MariusStorhaug Jul 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 6 additions & 58 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,67 +1,15 @@
# 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'.
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

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.
When this module is implemented, command details should live in PowerShell help and generated documentation rather than being duplicated in this README.

## 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.
Loading