Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
Signed-off-by: Peter Macdonald <[email protected]>
  • Loading branch information
Parsifal-M committed May 6, 2024
1 parent 70dec65 commit 28ea6d4
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
3 changes: 2 additions & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ playwright.config.ts
**/build/**
**/.git/**
**/templates/**
**/sample-templates/**
**/sample-templates/**
**/.yarn/**
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,16 @@ Like what you see? Feel free to star this repository and share it with your frie

Run the following yarn commands to add all the required packages to your Backstage application:

In your `packages/app` directory:

```bash
yarn add @parsifal-m/backstage-plugin-open-feedback
```

In your `packages/backend` directory:

```bash
yarn add @parsifal-m/backstage-plugin-open-feedback-backend @parsifal-m/backstage-plugin-open-feedback-common @parsifal-m/backstage-plugin-open-feedback
yarn add @parsifal-m/backstage-plugin-open-feedback-backend
```

## Adding the OpenFeedback Backend to your Backstage Application
Expand Down Expand Up @@ -79,7 +87,7 @@ import { OpenFeedbackModal } from '@parsifal-m/backstage-plugin-open-feedback';
<Sidebar>
{/* Other SidebarItems */}
<SidebarItem
icon={ThumbUpAltIcon}
icon={ThumbUpAltIcon} // You do not have to use this icon, it can be any!
to="/open-feedback-modal"
text="OpenFeedbackModal"
/>
Expand Down

0 comments on commit 28ea6d4

Please sign in to comment.