From e34bb827ed336a8fb7cca9e847fbceb35ae6409e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Richard=20Roch=C3=A9?= <richard.j.roche@gmail.com>
Date: Tue, 19 Nov 2024 14:25:25 +0000
Subject: [PATCH] fix: use the correct reference of the npm package (#4)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

<!-- 👋 Hi, thanks for sending a PR to home-run! 💖.
Please fill out all fields below and make sure each item is true and [x]
checked.
Otherwise we may not be able to review your PR. -->

## PR Checklist

- [ ] Addresses an existing open issue: fixes #000
- [ ] That issue was marked as [`status: accepting
prs`](https://github.com/investec/home-run/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [x] Steps in
[CONTRIBUTING.md](https://github.com/investec/home-run/blob/main/.github/CONTRIBUTING.md)
were taken

## Overview

This PR corrects the npm package shield as well as corrects the usage
references.
---
 README.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 7969e49..d7a29dd 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@
     <a href="https://github.com/investec/home-run/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="🤝 Code of Conduct: Kept" src="https://img.shields.io/badge/%F0%9F%A4%9D_code_of_conduct-kept-21bb42" /></a>
     <a href="https://codecov.io/gh/investec/home-run" target="_blank"><img alt="🧪 Coverage" src="https://img.shields.io/codecov/c/github/investec/home-run?label=%F0%9F%A7%AA%20coverage" /></a>
     <a href="https://github.com/investec/home-run/blob/main/LICENSE.md" target="_blank"><img alt="📝 License: MIT" src="https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg"></a>
-    <a href="http://npmjs.com/package/home-run"><img alt="📦 npm version" src="https://img.shields.io/npm/v/home-run?color=21bb42&label=%F0%9F%93%A6%20npm" /></a>
+    <a href="https://www.npmjs.com/package/@investec/home-run"><img alt="📦 npm version" src="https://img.shields.io/npm/v/%40investec%2Fhome-run?color=21bb42&label=%F0%9F%93%A6%20npm" /></a>
     <img alt="💪 TypeScript: Strict" src="https://img.shields.io/badge/%F0%9F%92%AA_typescript-strict-21bb42.svg" />
 </p>
 
@@ -73,7 +73,7 @@ It's possible to integrate `home-run` into a `package.json` script like so:
 
 ```json
 "scripts": {
-    "home-run": "@investec/home-run --mode explicit --subscriptionName our-subscription --resourceGroupName rg-our-resource-group --type containerapp --name ca-ourapp-dev --keyVaultName kv-ourapp-dev --appLocation ./src/OurContainerApp"
+    "home-run": "home-run --mode explicit --subscriptionName our-subscription --resourceGroupName rg-our-resource-group --type containerapp --name ca-ourapp-dev --keyVaultName kv-ourapp-dev --appLocation ./src/OurContainerApp"
 }
 ```
 
@@ -123,7 +123,7 @@ To integrate `home-run` into your `package.json` scripts, you can do something l
 
 ```json
 "scripts": {
-    "home-run": "@investec/home-run --mode resourcegroup --subscriptionName our-subscription --resourceGroupName rg-our-resource-group --type containerapp --appLocation ./src/OurContainerApp"
+    "home-run": "home-run --mode resourcegroup --subscriptionName our-subscription --resourceGroupName rg-our-resource-group --type containerapp --appLocation ./src/OurContainerApp"
 }
 ```