From e7c5e4b3036029c5f1818317a01b5b15b0113724 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Tue, 1 Jun 2021 20:13:22 +0200 Subject: [PATCH] packages: update outdated installation instructions Signed-off-by: Patrik Oldsberg --- .changeset/long-jokes-end.md | 11 +++++++++++ packages/cli/README.md | 8 +------- packages/core-app-api/README.md | 11 +++-------- packages/core-components/README.md | 11 +++-------- packages/core-plugin-api/README.md | 11 +++-------- packages/dev-utils/README.md | 9 ++------- packages/test-utils/README.md | 9 ++------- packages/theme/README.md | 9 ++------- 8 files changed, 27 insertions(+), 52 deletions(-) create mode 100644 .changeset/long-jokes-end.md diff --git a/.changeset/long-jokes-end.md b/.changeset/long-jokes-end.md new file mode 100644 index 0000000000..4c88d232fa --- /dev/null +++ b/.changeset/long-jokes-end.md @@ -0,0 +1,11 @@ +--- +'@backstage/cli': patch +'@backstage/core-app-api': patch +'@backstage/core-components': patch +'@backstage/core-plugin-api': patch +'@backstage/dev-utils': patch +'@backstage/test-utils': patch +'@backstage/theme': patch +--- + +Update installation instructions in README. diff --git a/packages/cli/README.md b/packages/cli/README.md index eb5e0e461b..1aa4233032 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -4,13 +4,7 @@ This package provides a CLI for developing Backstage plugins and apps. ## Installation -Install the package via npm or Yarn: - -```sh -npm install --save @backstage/cli -``` - -or +Install the package via Yarn: ```sh yarn add @backstage/cli diff --git a/packages/core-app-api/README.md b/packages/core-app-api/README.md index 28f206cc39..f98021250f 100644 --- a/packages/core-app-api/README.md +++ b/packages/core-app-api/README.md @@ -4,16 +4,11 @@ This package provides the core API used by Backstage apps. ## Installation -Install the package via Yarn or npm: +Install the package via Yarn: ```sh -$ yarn add @backstage/core-app-api -``` - -or - -```sh -$ npm install --save @backstage/core-app-api +cd packages/app +yarn add @backstage/core-app-api ``` ## Documentation diff --git a/packages/core-components/README.md b/packages/core-components/README.md index e8d4b607d3..4d12e903b3 100644 --- a/packages/core-components/README.md +++ b/packages/core-components/README.md @@ -4,16 +4,11 @@ This package provides the core components used by Backstage plugins and apps ## Installation -Install the package via Yarn or npm: +Install the package via Yarn: ```sh -$ yarn add @backstage/core-components -``` - -or - -```sh -$ npm install --save @backstage/core-components +cd # if within a monorepo +yarn add @backstage/core-components ``` ## Documentation diff --git a/packages/core-plugin-api/README.md b/packages/core-plugin-api/README.md index 0d3c699b91..ff4f469b11 100644 --- a/packages/core-plugin-api/README.md +++ b/packages/core-plugin-api/README.md @@ -4,16 +4,11 @@ This package provides the core API used by Backstage plugins. ## Installation -Install the package via Yarn or npm: +Install the package via Yarn: ```sh -$ yarn add @backstage/core-plugin-api -``` - -or - -```sh -$ npm install --save @backstage/core-plugin-api +cd # if within a monorepo +yarn add @backstage/core-plugin-api ``` ## Documentation diff --git a/packages/dev-utils/README.md b/packages/dev-utils/README.md index 85d961ad0b..78fa3bf7f6 100644 --- a/packages/dev-utils/README.md +++ b/packages/dev-utils/README.md @@ -6,15 +6,10 @@ This package provides utilities that help in developing plugins for Backstage, l ## Installation -Install the package via npm or Yarn: - -```sh -npm install --save-dev @backstage/dev-utils -``` - -or +Install the package via Yarn: ```sh +cd plugins/ # if within a monorepo yarn add -D @backstage/dev-utils ``` diff --git a/packages/test-utils/README.md b/packages/test-utils/README.md index ace7339733..d32ebcaf02 100644 --- a/packages/test-utils/README.md +++ b/packages/test-utils/README.md @@ -4,15 +4,10 @@ This package provides utilities that can be used to test plugins and apps for Ba ## Installation -Install the package via npm or Yarn: - -```sh -npm install --save-dev @backstage/test-utils -``` - -or +Install the package via Yarn: ```sh +cd # if within a monorepo yarn add -D @backstage/test-utils ``` diff --git a/packages/theme/README.md b/packages/theme/README.md index de94ff1623..0dc4059745 100644 --- a/packages/theme/README.md +++ b/packages/theme/README.md @@ -4,15 +4,10 @@ This package provides the extended Material UI Theme(s) that power Backstage. ## Installation -Install the package via npm or Yarn: - -```sh -npm install --save @backstage/theme -``` - -or +Install the package via Yarn: ```sh +cd # if within a monorepo yarn add @backstage/theme ```