From 35bc0a7c27b717943ea78737ff73c0f2d44a5eb4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Tue, 7 Jun 2022 09:30:23 +0200 Subject: [PATCH] update catalog client readme to correctly point to catalog-react MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- .changeset/ten-suits-prove.md | 5 +++++ packages/catalog-client/README.md | 7 +++---- 2 files changed, 8 insertions(+), 4 deletions(-) create mode 100644 .changeset/ten-suits-prove.md diff --git a/.changeset/ten-suits-prove.md b/.changeset/ten-suits-prove.md new file mode 100644 index 0000000000..a8f648b71e --- /dev/null +++ b/.changeset/ten-suits-prove.md @@ -0,0 +1,5 @@ +--- +'@backstage/catalog-client': patch +--- + +Update README to point to catalog-react for frontend usage diff --git a/packages/catalog-client/README.md b/packages/catalog-client/README.md index 574e23cf62..330c1f3ea1 100644 --- a/packages/catalog-client/README.md +++ b/packages/catalog-client/README.md @@ -5,10 +5,9 @@ Backstage Catalog. Backend code may import and use this package directly. -However, frontend code will not want to import this package directly - use the -`@backstage/plugin-catalog` package instead, which re-exports all of the types -and classes from this package. Thereby, you will also gain access to its -`catalogApiRef`. +However, frontend code will not want to instantiate a catalog client directly - +use the `@backstage/plugin-catalog-react` package instead, which exports a +`catalogApiRef` that can be leveraged like other frontend utility APIs. ## Links