From ffe9bae35ee179eeb37be868d036706e580ba169 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Thu, 27 May 2021 23:50:08 +0200 Subject: [PATCH] core-*: update READMEs Signed-off-by: Patrik Oldsberg --- packages/core-app-api/README.md | 16 +++++++++------- packages/core-components/README.md | 12 ++++++------ packages/core-plugin-api/README.md | 12 ++++++------ 3 files changed, 21 insertions(+), 19 deletions(-) diff --git a/packages/core-app-api/README.md b/packages/core-app-api/README.md index 4b8cfaaf93..28f206cc39 100644 --- a/packages/core-app-api/README.md +++ b/packages/core-app-api/README.md @@ -1,20 +1,22 @@ # @backstage/core-app-api -This package provides the core API used by Backstage plugins and apps. +This package provides the core API used by Backstage apps. ## Installation -```sh -$ npm install --save @backstage/core-app-api -``` - -or +Install the package via Yarn or npm: ```sh $ yarn add @backstage/core-app-api ``` +or + +```sh +$ npm install --save @backstage/core-app-api +``` + ## Documentation - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md) -- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md) +- [Backstage Documentation](https://backstage.io/docs) diff --git a/packages/core-components/README.md b/packages/core-components/README.md index 6d8519d46f..e8d4b607d3 100644 --- a/packages/core-components/README.md +++ b/packages/core-components/README.md @@ -1,22 +1,22 @@ -# @backstage/core +# @backstage/core-components -This package provides the core API used by Backstage plugins and apps. +This package provides the core components used by Backstage plugins and apps ## Installation -Install the package via npm or Yarn: +Install the package via Yarn or npm: ```sh -$ npm install --save @backstage/core +$ yarn add @backstage/core-components ``` or ```sh -$ yarn add @backstage/core +$ npm install --save @backstage/core-components ``` ## Documentation - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md) -- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md) +- [Backstage Documentation](https://backstage.io/docs) diff --git a/packages/core-plugin-api/README.md b/packages/core-plugin-api/README.md index f7b8b6c337..0d3c699b91 100644 --- a/packages/core-plugin-api/README.md +++ b/packages/core-plugin-api/README.md @@ -1,22 +1,22 @@ -# @backstage/core-api +# @backstage/core-plugin-api -This package provides the core API used by Backstage plugins and apps. +This package provides the core API used by Backstage plugins. ## Installation -Do not install this package directly, it is reexported by `@backstage/core`. Install that instead: +Install the package via Yarn or npm: ```sh -$ npm install --save @backstage/core +$ yarn add @backstage/core-plugin-api ``` or ```sh -$ yarn add @backstage/core +$ npm install --save @backstage/core-plugin-api ``` ## Documentation - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md) -- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md) +- [Backstage Documentation](https://backstage.io/docs)