Remove WIP

Signed-off-by: Adam Harvey <adaharve@cisco.com>
2021-04-19 20:35:56 -04:00
parent 3b2d4d421a
commit 9b9a8f39b6
1 changed files with 16 additions and 3 deletions
@@ -1,12 +1,25 @@
-# Catalog Frontend
-
-WORK IN PROGRESS
+# Backstage Catalog Frontend

 This is the frontend part of the default catalog plugin.

 It will implement the core API for handling your catalog of software, and
 supply the base views to show and manage them.

+## Getting Started
+
+This frontend plugin can be started in a standalone mode from directly in this package
+with `yarn start`. However, it will have limited functionality and that process is
+most convenient when developing the catalog frontend plugin itself.
+
+To evaluate the catalog and have a greater amount of functionality available, from the main
+Backstage root folder, instead do:
+
+```bash
+yarn dev
+```
+
+This will launch both the front and backend in same window, populated some example entities.
+
 ## Links

 - [Backend part of the plugin](https://github.com/backstage/backstage/tree/master/plugins/catalog-backend)