From 7d96ba8370f0eaa83046082253591825d96c9bad Mon Sep 17 00:00:00 2001
From: samstitt <145553195+samstitt@users.noreply.github.com>
Date: Thu, 28 Dec 2023 17:03:32 +0000
Subject: [PATCH] chore: added install path and fixed import on
 plugin-octopus-deploy

Signed-off-by: samstitt <145553195+samstitt@users.noreply.github.com>
---
 .changeset/hip-dancers-pay.md    |  5 +++++
 plugins/octopus-deploy/README.md | 13 ++++++++++++-
 2 files changed, 17 insertions(+), 1 deletion(-)
 create mode 100644 .changeset/hip-dancers-pay.md

diff --git a/.changeset/hip-dancers-pay.md b/.changeset/hip-dancers-pay.md
new file mode 100644
index 0000000000..b05a291f85
--- /dev/null
+++ b/.changeset/hip-dancers-pay.md
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-octopus-deploy': patch
+---
+
+added install path and fixed import on plugin-octopus-deploy
diff --git a/plugins/octopus-deploy/README.md b/plugins/octopus-deploy/README.md
index 9e37777091..3699b76678 100644
--- a/plugins/octopus-deploy/README.md
+++ b/plugins/octopus-deploy/README.md
@@ -8,6 +8,17 @@ Welcome to the octopus-deploy plugin!
 
 ## Getting started
 
+### Installing
+
+To get started, first install the plugin with the following command:
+
+```bash
+# From your Backstage root directory
+yarn add --cwd packages/app @backstage/plugin-octopus-deploy
+```
+
+### Setup
+
 This plugin (currently) uses the Backstage proxy to securely communicate with the Octopus Deploy API.
 
 To use it, you will need to generate an [API Key](https://octopus.com/docs/octopus-rest-api/how-to-create-an-api-key) within Octopus Deploy.
@@ -35,7 +46,7 @@ octopusdeploy:
 ```
 // In packages/app/src/components/catalog/EntityPage.tsx
 import {
-  isOctopusDeployAvailable
+  isOctopusDeployAvailable,
   EntityOctopusDeployContent
 } from '@backstage/plugin-octopus-deploy';