🌟 [Major]: First release (#2)

## Description

- Runs a PowerShell script with the GitHub PowerShell module.

## Type of change

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

- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [ ] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [x] 🌟 [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

Author: MariusStorhaug

.github/workflows/Action-Test.yml

@@ -24,16 +24,8 @@ jobs:
       - name: Action-Test
         uses: ./
         with:
-          script: |
-            LogGroup "Test-PSModule" {
-              Get-GitHubZen
-            }
-
-      - name: Action-Test 2
-        uses: ./
-        with:
-          Verbose: true
-          script: |
-            LogGroup "Test-PSModule" {
+          Token: ${{ github.token }}
+          Script: |
+            LogGroup "Get-GitHubZen" {
               Get-GitHubZen
             }

README.md

@@ -1,6 +1,6 @@
 # GitHub-Script
 
-A GitHub Action used for running a PowerShell Script that uses the GitHub PowerShell module
+A GitHub Action used for running a PowerShell Script that uses the GitHub PowerShell module.
 
 ## Usage
 
@@ -12,35 +12,52 @@ A GitHub Action used for running a PowerShell Script that uses the GitHub PowerS
 | `Token` | The GitHub token to use | false | ${{ github.token }} |
 | `Debug` | Enable debug output | false | 'false' |
 | `Verbose` | Enable verbose output | false | 'false' |
-| `Version` | The version of the GitHub module to install | false | 'latest' |
+| `Version` | Specifies the version of the resource to be returned. The value can be an exact version or a version range using the NuGet versioning syntax. | false | 'latest' |
 | `Prerelease` | Allow prerelease versions if available | false | 'false' |
 | `WorkingDirectory` | The working directory where the script will run from | false | ${{ github.workspace }} |
 
-<!--
-    Token
-    JWT
-    AppID
-    Repos
-    Organization
-    Host -> github.com, *.ghe.com
--->
+### Examples
 
-<!-- ### Secrets -->
+#### Example 1: Run a script that uses the GitHub PowerShell module
 
-<!--
-    Token
-    JWT
--->
+Run a script that uses the GitHub PowerShell module.
+This example runs a non-authenticated script that gets the GitHub Zen message.
 
-<!-- ### Outputs -->
+```yaml
+jobs:
+  Run-Script:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Run script
+        uses: PSModule/GitHub-Script@v1
+        with:
+          Script: |
+            LogGroup "Get-GitHubZen" {
+              Get-GitHubZen
+            }
+```
+
+#### Example 2: Run a script that uses the GitHub PowerShell module with a token
 
-### Example
+Run a script that uses the GitHub PowerShell module with a token.
+This example runs an authenticated script that gets the GitHub Zen message.
 
 ```yaml
-Example here
+jobs:
+  Run-Script:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Run script
+        uses: PSModule/GitHub-Script@v1
+        with:
+          Token: ${{ github.token }}
+          Script: |
+            LogGroup "Get-GitHubZen" {
+              Get-GitHubZen
+            }
 ```
 
-### Similar projects
+## Related projects
 
 - [actions/create-github-app-token](https://github.com/actions/create-github-app-token) -> Functionality will be brought into GitHub PowerShell module.
 - [actions/github-script](https://github.com/actions/github-script)

action.yml

@@ -12,7 +12,6 @@ inputs:
   Token:
     description: The GitHub token to use.
     required: false
-    default: ${{ github.token }}
   Debug:
     description: Enable debug output.
     required: false
@@ -55,6 +54,6 @@ runs:
         if ($env:GITHUB_ACTION_INPUT_Verbose -eq 'true') {
           $VerbosePreference = 'Continue'
         }
-        . "$env:GITHUB_ACTION_PATH\scripts\main.ps1"
+        . "${{ github.action_path }}\scripts\main.ps1"
 
         ${{ inputs.Script }}