diff --git a/README.md b/README.md index 940ddb76c..8c801d885 100644 --- a/README.md +++ b/README.md @@ -126,6 +126,7 @@ For a list and description of features offered by the AsyncAPI React component, ## Styles +### Default styles To use default styles import them as follows: ``` js @@ -134,6 +135,70 @@ import "@asyncapi/react-component/styles/default.css"; import "@asyncapi/react-component/styles/default.min.css"; ``` +### Custom styles +The AsyncAPI React component does not set any global fonts. This component allows the usage of your custom `font-family` and other styling. + +This can be done by defining the styles in a file or inline using a ` + + + + ... + +``` + +### Custom logo + +The AsyncAPI component supports the option to use a custom logo. By using the `x-logo` custom extension in the [InfoObject](https://github.com/asyncapi/spec/blob/master/spec/asyncapi.md#infoObject), a logo will be shown in the top left corner. + +> **NOTE**: The logo will only appear if the [sidebar option](./docs/configuration/config-modification.md#definition) is enabled. + +```yaml +asyncapi: 2.2.0 +info: + title: Account Service + version: 1.0.0 + description: This service is in charge of processing user signups. + x-logo: 'https://raw.githubusercontent.com/asyncapi/spec/master/assets/logo.png' +channels: + ... +``` + ## Playground This repository comes in with a [Playground application](https://asyncapi.github.io/asyncapi-react/). Test it to see the component in action and play with it before you use it in your application.