From d0e71b2cf558822c040143f76803d6c5efb65584 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Olav=20R=C3=B8nnestad=20Birkeland?=
 <6450056+o-l-a-v@users.noreply.github.com>
Date: Thu, 1 Aug 2024 17:21:48 +0200
Subject: [PATCH] Update readme with more info and consistent markdown syntax
 for headings and lists (#1675)

---
 README.md | 77 ++++++++++++++++++++++++++-----------------------------
 1 file changed, 36 insertions(+), 41 deletions(-)

diff --git a/README.md b/README.md
index 62f94fcea..5222ac17a 100644
--- a/README.md
+++ b/README.md
@@ -1,61 +1,56 @@
+# PSResourceGet
 
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/PowerShell/PSResourceGet/blob/master/LICENSE)
-[![Documentation - PSResourceGet](https://img.shields.io/badge/Documentation-PowerShellGet-blue.svg)](https://docs.microsoft.com/en-us/powershell/module/powershellget/?view=powershell-7.1)
+[![Documentation - PSResourceGet](https://img.shields.io/badge/Documentation-PowerShellGet-blue.svg)](https://learn.microsoft.com/powershell/module/microsoft.powershell.psresourceget)
 [![PowerShell Gallery - PSResourceGet](https://img.shields.io/badge/PowerShell%20Gallery-PSResourceGet-blue.svg)](https://www.powershellgallery.com/packages/Microsoft.PowerShell.PSResourceGet)
 [![Minimum Supported PowerShell Version](https://img.shields.io/badge/PowerShell-5.0-blue.svg)](https://github.com/PowerShell/PSResourceGet)
 
-Important Note
-==============
+## Important Notes
 
-If you were familiar with the PowerShellGet 3.0 project, we renamed the module to be PSResourceGet, for more information please read [this blog](https://devblogs.microsoft.com/powershell/powershellget-in-powershell-7-4-updates/).
+> [!NOTE]
+> `PSResourceGet` is short for the full name of the module, `Microsoft.PowerShell.PSResourceGet`.  The full name is what is used in PowerShell and when published to the [PowerShell Gallery](https://www.powershellgallery.com/packages/Microsoft.PowerShell.PSResourceGet).
 
-If you would like to open a PR please open an issue first so that necessary discussion can take place.
-Please open an issue for any feature requests, bug reports, or questions for PSResourceGet.
-Please note, the repository for PowerShellGet v2 is available at [PowerShell/PowerShellGetv2](https://github.com/PowerShell/PowerShellGetv2).
-The repository for the PowerShellGet v3, the compatibility layer between PowerShellGet v2 and PSResourceGet, is available at [PowerShell/PowerShellGet](https://github.com/PowerShell/PowerShellGet).
+* If you were familiar with the PowerShellGet 3.0 project, we renamed the module to be PSResourceGet, for more information please read [this blog](https://devblogs.microsoft.com/powershell/powershellget-in-powershell-7-4-updates/).
+* If you would like to open a PR please open an issue first so that necessary discussion can take place.
+  * Please open an issue for any feature requests, bug reports, or questions for PSResourceGet.
+  * See the [Contributing Quickstart Guide](#contributing-quickstart-guide) section.
+* Please note, the repository for PowerShellGet v2 is available at [PowerShell/PowerShellGetv2](https://github.com/PowerShell/PowerShellGetv2).
+* The repository for the PowerShellGet v3, the compatibility layer between PowerShellGet v2 and PSResourceGet, is available at [PowerShell/PowerShellGet](https://github.com/PowerShell/PowerShellGet).
 
-Introduction
-============
+## Introduction
 
 PSResourceGet is a PowerShell module with commands for discovering, installing, updating and publishing the PowerShell resources like Modules, Scripts, and DSC Resources.
 
-Documentation
-=============
+## Documentation
 
-Documentation for PSResourceGet is currently under its old name PowerShellGet v3, please
-[Click here](https://learn.microsoft.com/powershell/module/powershellget/?view=powershellget-3.x)
-to reference the documentation.
+[Click here](https://learn.microsoft.com/powershell/module/microsoft.powershell.psresourceget) to reference the documentation.
 
-Requirements
-============
+## Requirements
 
-- PowerShell 5.0 or higher.
+* PowerShell 5.0 or higher.
 
-Get PSResourceGet Module
-========================
+## Install the PSResourceGet module
 
+* `PSResourceGet` is short for the full name `Microsoft.PowerShell.PSResourceGet`.
+* It's included in PowerShell since v7.4.
 Please use the [PowerShell Gallery](https://www.powershellgallery.com) to get the latest version of the module.
 
-Get PowerShellGet Source
-========================
+## Contributing Quickstart Guide
 
-#### Steps
-
-* Obtain the source
-    - Download the latest source code from the release page (https://github.com/PowerShell/PSResourceGet/releases) OR
-    - Clone the repository (needs git)
-    ```powershell
-    git clone https://github.com/PowerShell/PSResourceGet
-    ```
+### Get the source code
 
+* Download the latest source code from the release page (<https://github.com/PowerShell/PSResourceGet/releases>) OR clone the repository using git.
+  ```powershell
+  PS > cd 'C:\Repos'
+  PS C:\Repos> git clone https://github.com/PowerShell/PSResourceGet
+  ```
 * Navigate to the local repository directory
+  ```powershell
+  PS C:\> cd c:\Repos\PSResourceGet
+  PS C:\Repos\PSResourceGet>
+  ```
 
-```powershell
-PS C:\> cd c:\Repos\PSResourceGet
-PS C:\Repos\PSResourceGet>
-```
-
-* Build the project
+### Build the project
 
 ```powershell
 # Build for the net472 framework
@@ -65,6 +60,8 @@ PS C:\Repos\PSResourceGet> .\build.ps1 -Clean -Build -BuildConfiguration Debug -
 PS C:\Repos\PSResourceGet> .\build.ps1 -Clean -Build -BuildConfiguration Debug -BuildFramework netstandard2.0
 ```
 
+### Publish the module to a local repository
+=======
 * Run functional tests
 
 ```powershell
@@ -75,7 +72,7 @@ PS C:\Repos\PSResourceGet> Invoke-Pester
 PS C:\Repos\PSResourceGet> Invoke-Pester <file-name>
 ```
 
-* Import the module into a new PowerShell session
+### Import the built module into a new PowerShell session
 
 ```powershell
 # If running PowerShell 6+
@@ -87,12 +84,10 @@ c:\> PowerShell
 C:\> Import-Module C:\Repos\PSResourceGet\out\PSResourceGet\PSResourceGet.psd1
 ```
 
-Code of Conduct
-===============
+## Code of Conduct
 
 Please see our [Code of Conduct](CODE_OF_CONDUCT.md) before participating in this project.
 
-Security Policy
-===============
+## Security Policy
 
 For any security issues, please see our [Security Policy](SECURITY.md).