paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 46 Packages Projects Releases Wiki Activity

core-*: update READMEs

Browse Source 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2021-05-27 23:50:08 +02:00
parent 606ce2a262
commit ffe9bae35e
3 changed files with 21 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/core-app-api/README.md
+9 -7
View File
@@ -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)
packages/core-components/README.md
+6 -6
View File
@@ -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)
packages/core-plugin-api/README.md
+6 -6
View File
@@ -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)