paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

update catalog client readme to correctly point to catalog-react

Browse Source 
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
Fredrik Adelöw
2022-06-07 09:30:23 +02:00
parent b90b51980d
commit 35bc0a7c27
2 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/ten-suits-prove.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/catalog-client': patch
---
Update README to point to catalog-react for frontend usage
packages/catalog-client/README.md
+3 -4
View File
@@ -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