update README for frontend plugin

Signed-off-by: Rickard Dybeck <dybeck@spotify.com>
2023-05-25 13:44:44 -04:00
parent 269a58bacc
commit d1ec449691
1 changed files with 18 additions and 2 deletions
@@ -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