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

backend-*: updated READMEs

Browse Source 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2023-02-14 13:55:45 +01:00
parent c3c928db92
commit 725383f69d
5 changed files with 36 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/backend-plugin-api/README.md
+5 -4
View File
@@ -1,19 +1,20 @@
# @backstage/backend-plugin-api
**This package is HIGHLY EXPERIMENTAL, do not use this for production**
**This package is EXPERIMENTAL, but we encourage use of it to add support for the new backend system in your own plugins**
This package provides the core API used by Backstage backend plugins.
This package provides the core API used by Backstage backend plugins and modules.
## Installation
Add the library to your backend plugin package:
Add the library to your backend plugin or module package:
```bash
# From your Backstage root directory
yarn add --cwd plugin/<plugin>-backend @backstage/backend-plugin-api
yarn add --cwd plugins/<plugin>-backend @backstage/backend-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 Backend System](https://backstage.io/docs/backend-system/)