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/cli/package.json b/packages/cli/package.json index 9cc9ee6aa7..657315d959 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,9 +1,22 @@ { "name": "@spotify-backstage/cli", + "description": "CLI for developing Backstage plugins and apps", "version": "0.1.0", - "main": "dist", - "license": "Apache-2.0", "private": false, + "publishConfig": { + "access": "public" + }, + "homepage": "https://backstage.io", + "repository": { + "type": "git", + "url": "https://github.com/spotify/backstage", + "directory": "packages/cli" + }, + "keywords": [ + "backstage" + ], + "license": "Apache-2.0", + "main": "dist", "scripts": { "exec": "npx ts-node ./src", "build": "tsc --outDir dist --noEmit false --module CommonJS", 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/core/package.json b/packages/core/package.json index b6ceeb42f2..d1fb12fdec 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,8 +1,21 @@ { "name": "@spotify-backstage/core", + "description": "Core API used by Backstage plugins and apps", "version": "0.1.0", - "license": "Apache-2.0", "private": false, + "publishConfig": { + "access": "public" + }, + "homepage": "https://backstage.io", + "repository": { + "type": "git", + "url": "https://github.com/spotify/backstage", + "directory": "packages/core" + }, + "keywords": [ + "backstage" + ], + "license": "Apache-2.0", "main": "dist/cjs/index.js", "types": "dist/cjs/index.d.ts", "scripts": { 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)