Merge pull request #56 from flcdrg/add-README

Add README to nuspec

Author: flcdrg

.github/workflows/main.yml

@@ -18,10 +18,13 @@ jobs:
       Release_html_url: ${{ steps.create_release.outputs.html_url}}
       Release_upload_url: ${{ steps.create_release.outputs.upload_url}}
 
+    permissions:
+      contents: write
+
     steps:
-      - uses: GitHubSecurityLab/actions-permissions/monitor@v1
-        with:
-          config: ${{ vars.PERMISSIONS_CONFIG }}
+      # - uses: GitHubSecurityLab/actions-permissions/monitor@v1
+      #   with:
+      #     config: ${{ vars.PERMISSIONS_CONFIG }}
 
       - name: Checkout
         uses: actions/checkout@v4

PowerShellWixExtension.nuspec

@@ -14,12 +14,14 @@
         <requireLicenseAcceptance>false</requireLicenseAcceptance>
         <tags>WiX PowerShell MSI Installer WixToolset XML</tags>
         <releaseNotes>$releasenotes$</releaseNotes>
+        <readme>docs\README.md</readme>
     </metadata>
     <files>
         <file src="NuGet\content\*.*" target="content" /> 
         <file src="NuGet\tools\**\*.*" target="tools" /> 
         <file src="LICENSE.txt" />
         <file src="MSRL-LICENSE.txt" />
+        <file src="README.md" target="docs\" />
     </files>
 
 </package>

README.md

@@ -1,31 +1,32 @@
-PowerShellWixExtension
-======================
+# PowerShellWixExtension
 
 A Wix Extension for running PowerShell scripts
 
-NuGet Package
--------------
+## NuGet Package
+
 [![NuGet](https://img.shields.io/nuget/v/PowerShellWixExtension.svg?maxAge=2592)](https://www.nuget.org/packages/PowerShellWixExtension/) [![AppVeyor](https://ci.appveyor.com/api/projects/status/github/flcdrg/PowerShellWixExtension?style=plastic)](https://ci.appveyor.com/project/DavidGardiner/powershellwixextension)
 
 All ready to add to an existing Wix project. Grab the latest version from https://www.nuget.org/packages/PowerShellWixExtension/
 
-Getting Started
----------------
+## Getting Started
+
 1. Add a reference to the PowerShellWixExtension.dll in your Wix Setup Project (NuGet package recommended)
 2. Add namespace to .wxs file
-```
+
+```xml
     <?xml version="1.0" encoding="UTF-8"?>
     <Wix xmlns="http://schemas.microsoft.com/wix/2006/wi" xmlns:powershell="http://schemas.gardiner.net.au/PowerShellWixExtensionSchema">
 ```
 
 4. To execute a .ps1 file that ships with the project
 
-```
+```xml
    <powershell:File Id="PSFile1" File="[#TestPs1]" Arguments="&quot;First Argument&quot; 2"/>
 ```
 
 5. To execute inline script use
-```
+
+```xml
     <powershell:Script Id="Script2">
       <![CDATA[
         # Write-Host "Number 2";
@@ -39,21 +40,21 @@ Getting Started
         ]]>
     </powershell:Script>
 ```
-    
-Notes
------
+
+## Notes
 
 ### Custom sequences
 
-You can customise when a set of scripts are run by adding your own <Custom /> element inside your <InstallExecuteSequence /> element. eg.
+You can customise when a set of scripts are run by adding your own `<Custom />` element inside your `<InstallExecuteSequence />` element. eg.
 
-```
+```xml
       <InstallExecuteSequence>
         <Custom Action="PowerShellScriptsDeferred" After="RegisterUser">NOT Installed</Custom>
       </InstallExecuteSequence>
-````
+```
 
 The four defined actions are:
+
 1. `PowerShellScriptsDeferred`
 2. `PowerShellScriptsElevatedDeferred`
 3. `PowerShellFilesDeferred`