π₯ React build status badge component for any CI/CD service. Shows real-time status and supports Markdown for easy setup.
MIT License
Read the official documentation.
ποΈ Live Demo
BuildStatusBadge is a React component that allows you to put a real-time build status badge on your site.
The badge automatically updates as the status changesβno clearing the cache or refreshing the page required.
Just paste in your status badge Markdown and you're ready to go. Additional options are available.
If this project helped you, please consider buying me a coffee or sponsoring me. Your support is much appreciated!
Β
npm i react-build-status-badge
import { BuildStatusBadge } from "react-build-status-badge";
The easiest way is to simply paste in your badge Markdown image link, like so:
<BuildStatusBadge>
[![Deploy
Status](https://github.com/justinmahar/react-build-status-badge/workflows/Deploy/badge.svg)](https://github.com/justinmahar/react-build-status-badge/actions?query=workflow%3ADeploy)
</BuildStatusBadge>
See the BuildStatusBadge docs for additional methods and options.
Type definitions have been included for TypeScript support.
Favicon by Twemoji.
Open source software is awesome and so are you. π
Feel free to submit a pull request for bugs or additions, and make sure to update tests as appropriate. If you find a mistake in the docs, send a PR! Even the smallest changes help.
For major changes, open an issue first to discuss what you'd like to change.
If you found this project helpful, let the community know by giving it a star: πβ
See LICENSE.md.