update readme

Signed-off-by: Kiss Miklos <miklos@roadie.io>
This commit is contained in:
Kiss Miklos
2022-06-08 13:01:11 +02:00
parent e0328f2107
commit b9aeb42e65
+5 -1
View File
@@ -1,5 +1,9 @@
# @backstage/plugin-api-docs-react
This package contains ApiDefinitionWidgets for the following projects:
- [grpc-docs](https://github.com/gendocu-com/grpc-docs)
## Setup
```
@@ -8,7 +12,7 @@ yarn add @backstage/plugin-api-docs-react
## Add the GrpcDocsApiWidget to your apis
Add the widget to your `apiDocsConfigRef` in the following way. Make sure the `apiEntity.spec.type` is compared to `grpc-docs`
Add the widget to your `apiDocsConfigRef`.
```ts
import { grpcDocsApiWidget } from '@backstage/plugin-api-docs-react';