Skip to content

Commit

Permalink
📝 [Docs]: Add reference to the Template-Action that uses `GitHub-Sc…
Browse files Browse the repository at this point in the history
…ript` (#31)

## Description

This pull request includes a small change to the `README.md` file. The
change updates the description of the GitHub Action to better explain
its integration with the GitHub PowerShell module and provides a link to
create a new repository from a template.

- Fixes #29

Changes in documentation:

*
[`README.md`](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L3-R5):
Updated the description to clarify the integration with the GitHub
PowerShell module and added a link to create a new repository from the
PSModule template.

## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] 📖 [Docs]
- [ ] 🪲 [Fix]
- [ ] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [ ] 🌟 [Breaking change]

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas
  • Loading branch information
MariusStorhaug authored Jan 22, 2025
1 parent 8ada046 commit cdcb935
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# GitHub-Script

A GitHub Action for running a PowerShell script that uses the GitHub PowerShell module.
A GitHub Action for running a PowerShell that is integrated into GitHub using the [GitHub PowerShell module](https://psmodule.io/GitHub).

For more information on available functions and automatically loaded variables, see the
[GitHub PowerShell module documentation](https://psmodule.io/GitHub).
To get started with your own GitHub PowerShell based action, [create a new repository from PSModule/Template-Action](https://github.com/new?template_name=Template-Action&template_owner=PSModule).

## Usage

Expand Down

0 comments on commit cdcb935

Please sign in to comment.