From cf446052bc9f48f244700aac4b1a489fa7b8d42d Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Wed, 25 Mar 2020 12:57:54 +0100 Subject: [PATCH] packages: add READMEs --- packages/app/README.md | 3 +++ packages/cli/README.md | 22 ++++++++++++++++++++++ packages/core/README.md | 22 ++++++++++++++++++++++ packages/storybook/README.md | 3 +++ 4 files changed, 50 insertions(+) create mode 100644 packages/app/README.md create mode 100644 packages/cli/README.md create mode 100644 packages/core/README.md create mode 100644 packages/storybook/README.md diff --git a/packages/app/README.md b/packages/app/README.md new file mode 100644 index 0000000000..cabf812650 --- /dev/null +++ b/packages/app/README.md @@ -0,0 +1,3 @@ +# @spotify-backstage/app + +This package is an example of a Backstage application. diff --git a/packages/cli/README.md b/packages/cli/README.md new file mode 100644 index 0000000000..99afb635ce --- /dev/null +++ b/packages/cli/README.md @@ -0,0 +1,22 @@ +# @backstage/cli + +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 + +```sh +$ yarn add @backstage/cli +``` + +## Documentation + +- [Backstage Readme](https://github.com/spotify/backstage/blob/master/README.md) +- [Backstage Documentation](https://github.com/spotify/backstage/blob/master/docs/README.md) diff --git a/packages/core/README.md b/packages/core/README.md new file mode 100644 index 0000000000..a22f66ecd9 --- /dev/null +++ b/packages/core/README.md @@ -0,0 +1,22 @@ +# @backstage/core + +This package provides the core API used by Backstage plugins and apps. + +## Installation + +Install the package via npm or yarn: + +```sh +$ npm install --save @backstage/core +``` + +or + +```sh +$ yarn add @backstage/core +``` + +## Documentation + +- [Backstage Readme](https://github.com/spotify/backstage/blob/master/README.md) +- [Backstage Documentation](https://github.com/spotify/backstage/blob/master/docs/README.md) diff --git a/packages/storybook/README.md b/packages/storybook/README.md new file mode 100644 index 0000000000..2e716a5466 --- /dev/null +++ b/packages/storybook/README.md @@ -0,0 +1,3 @@ +# storybook + +This package provides a storybook build for Backstage. See [storybook.backstage.io](http://storybook.backstage.io)