From d1ec449691ef2494cf92d898ca5f568780b1d8e9 Mon Sep 17 00:00:00 2001
From: Rickard Dybeck <dybeck@spotify.com>
Date: Thu, 25 May 2023 13:44:44 -0400
Subject: [PATCH] update README for frontend plugin

Signed-off-by: Rickard Dybeck <dybeck@spotify.com>
---
 .../catalog-unprocessed-entities/README.md    | 20 +++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)

diff --git a/plugins/catalog-unprocessed-entities/README.md b/plugins/catalog-unprocessed-entities/README.md
index 64caf8f3f1..fd824bec94 100644
--- a/plugins/catalog-unprocessed-entities/README.md
+++ b/plugins/catalog-unprocessed-entities/README.md
@@ -1,8 +1,24 @@
 # catalog-unprocessed-entities
 
-Welcome to the catalog-unprocessed-entities plugin!
+Frontend plugin to view unprocessed entities.
 
-_This plugin was created through the Backstage CLI_
+## Requirements
+
+Requires the `@backstage/plugin-catalog-backend-module-unprocessed` module to be installed.
+
+## Installation
+
+Import into your App.tsx and include into the `<FlatRoutes>` component:
+
+```tsx
+import { CatalogUnprocessedEntitiesPage } from '@backstage/plugin-catalog-unprocessed-entities';
+//...
+
+<Route
+  path="/catalog-unprocessed-entities"
+  element={<CatalogUnprocessedEntitiesPage />}
+/>;
+```
 
 ## Getting started