diff --git a/README.md b/README.md index c639b8cc9b2b0cdccb9f7d903cbb195d09b99d91..e0efe71bbfb7dbaa092af9746e63cef145db8660 100644 --- a/README.md +++ b/README.md @@ -34,4 +34,26 @@ For example: :root{ --sib-notifications-theme: #ffd759; } +``` + +# SiB Badge + +sib-badge is a component that displays the number of unread notifications in the inbox of the logged in user related to a resource or a container. + +As it uses the `bind-user`, you have to make sure to include a valid `sib-auth` configuration. + +## Usage +In your template, insert the following line where you want to display the component. +```html + +``` + +### Design +To customize your component, you can set the css variable `--sib-badge-theme` anywhere in your stylesheet to the color you want. +For example: + +```css +:root{ + --sib-badge-theme: #ffd759; +} ``` \ No newline at end of file