From 5dfa0cdb55852dbc29426315feff34b35d0b2d1e Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Tue, 22 Aug 2023 17:41:05 +0200 Subject: [PATCH] frontend-*-api: update README Signed-off-by: Patrik Oldsberg --- packages/frontend-app-api/README.md | 11 ++++------- packages/frontend-plugin-api/README.md | 11 ++++------- 2 files changed, 8 insertions(+), 14 deletions(-) diff --git a/packages/frontend-app-api/README.md b/packages/frontend-app-api/README.md index 5cc5073f61..8b2fe5dc23 100644 --- a/packages/frontend-app-api/README.md +++ b/packages/frontend-app-api/README.md @@ -1,12 +1,9 @@ # @backstage/frontend-app-api -_This package was created through the Backstage CLI_. +**This package is EXPERIMENTAL, we recommend against using it for production deployments** -## Installation +This package provides the core API used by Backstage frontend apps. It implements the design outlined in [RFC: Frontend System Evolution](https://github.com/backstage/backstage/issues/18372). -Install the package via Yarn: +## Documentation -```sh -cd # if within a monorepo -yarn add @backstage/frontend-app-api -``` +- [Backstage Documentation](https://backstage.io/docs) diff --git a/packages/frontend-plugin-api/README.md b/packages/frontend-plugin-api/README.md index 43cb4082dc..1fd3da79d8 100644 --- a/packages/frontend-plugin-api/README.md +++ b/packages/frontend-plugin-api/README.md @@ -1,12 +1,9 @@ # @backstage/frontend-plugin-api -_This package was created through the Backstage CLI_. +**This package is EXPERIMENTAL, we recommend against using it for production deployments** -## Installation +This package provides the core API used by Backstage frontend plugins. It implements the design outlined in [RFC: Frontend System Evolution](https://github.com/backstage/backstage/issues/18372). -Install the package via Yarn: +## Documentation -```sh -cd # if within a monorepo -yarn add @backstage/frontend-plugin-api -``` +- [Backstage Documentation](https://backstage.io/docs)