Skip to content

Commit a9b7247

Browse files
docs(readme): add badges
This displays the badges at the top of the README to display stats like if CI is passing etc.
1 parent 1965dea commit a9b7247

1 file changed

Lines changed: 66 additions & 1 deletion

File tree

README.md

Lines changed: 66 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,76 @@
11
<div align="center">
22
<picture>
3-
<source srcset="docs/assets/logo-standalone.svg" media="(max-width: 600px)">
3+
<source srcset="./docs/assets/logo-standalone.svg" media="(max-width: 600px)">
44
<img src="./docs/assets/logo-with-text.svg" width="50%" alt="the Slyde logo">
55
</picture>
66
<br>
77
<br>
88
<p>Make beautifully animated Slydes and presentations from XML with ease! </p>
9+
<badges-container data-why="since we can remove it before publishing an docker image or npm package">
10+
<hr>
11+
<!--~###################################~-->
12+
<!--~#### Open issues and PRs ####~-->
13+
<!--~###################################~-->
14+
<a href="https://github.com/Tygo-van-den-Hurk/Slyde/issues?q=is%3Aissue%20state%3Aopen%20label%3Afix">
15+
<picture>
16+
<source srcset="https://img.shields.io/github/issues/Tygo-van-den-Hurk/Slyde/fix?style=flat&labelColor=FFFFFF&color=f9c262&logoColor=5E2751&label=Bug%20Reports" media="(prefers-color-scheme: light)" />
17+
<img src="https://img.shields.io/github/issues/Tygo-van-den-Hurk/Slyde/fix?style=flat&labelColor=2F363D&color=FF8C2B&logoColor=8F5C86&label=Bug%20Reports" alt="Contributor covenant: 3.0" />
18+
</picture>
19+
</a>
20+
<a href="https://github.com/Tygo-van-den-Hurk/Slyde/issues?q=is%3Aissue%20state%3Aopen%20label%3Afeat">
21+
<picture>
22+
<source srcset="https://img.shields.io/github/issues/Tygo-van-den-Hurk/Slyde/feat?style=flat&labelColor=FFFFFF&color=f9c262&logoColor=5E2751&label=Feature%20Requests" media="(prefers-color-scheme: light)" />
23+
<img src="https://img.shields.io/github/issues/Tygo-van-den-Hurk/Slyde/feat?style=flat&labelColor=2F363D&color=FF8C2B&logoColor=8F5C86&label=Feature%20Requests" alt="GitHub open feature requests" />
24+
</picture>
25+
</a>
26+
<a href="https://github.com/Tygo-van-den-Hurk/Slyde/blob/main/LICENSE">
27+
<picture>
28+
<source srcset="https://img.shields.io/github/license/Tygo-van-den-Hurk/Slyde?style=flat&labelColor=FFFFFF&color=f9c262&logoColor=5E2751&label=Licence" media="(prefers-color-scheme: light)" />
29+
<img src="https://img.shields.io/github/license/Tygo-van-den-Hurk/Slyde?style=flat&labelColor=2F363D&color=FF8C2B&logoColor=8F5C86&label=Licence" alt="The Repository License badge" />
30+
</picture>
31+
</a>
32+
<a href="https://github.com/Tygo-van-den-Hurk/Slyde/stargazers">
33+
<picture>
34+
<source srcset="https://img.shields.io/github/stars/Tygo-van-den-Hurk/Slyde?style=flat&labelColor=FFFFFF&color=f9c262&label=Stars" media="(prefers-color-scheme: light)" />
35+
<img src="https://img.shields.io/github/stars/Tygo-van-den-Hurk/Slyde?style=flat&labelColor=2F363D&color=FF8C2B&label=Stars" alt="amount of stars on GitHub" />
36+
</picture>
37+
</a>
38+
<!-- ENABLE AFTER FIRST RELEASE
39+
<a href="https://github.com/Tygo-van-den-Hurk/Slyde/releases">
40+
<picture>
41+
<source srcset="https://img.shields.io/github/release/Tygo-van-den-Hurk/Slyde?style=flat&display_name=release&label=Release&labelColor=FFFFFF&color=f9c262" media="(prefers-color-scheme: light)" />
42+
<img src="https://img.shields.io/github/release/Tygo-van-den-Hurk/Slyde?style=flat&display_name=release&label=Release&labelColor=2F363D&color=FF8C2B" alt="newest release" />
43+
</picture>
44+
</a> -->
45+
<br>
46+
<!--~###################################~-->
47+
<!--~#### Repository CI/CD ####~-->
48+
<!--~###################################~-->
49+
<a href="https://github.com/Tygo-van-den-Hurk/Slyde/actions/workflows/push--deploy-github-pages.yaml">
50+
<picture>
51+
<source srcset="https://img.shields.io/github/actions/workflow/status/Tygo-van-den-Hurk/Slyde/push--deploy-github-pages.yaml?style=flat&labelColor=FFFFFF&color=f9c262&logo=readthedocs&logoColor=000000&label=Docs&branch=main&event=push" media="(prefers-color-scheme: light)" />
52+
<img src="https://img.shields.io/github/actions/workflow/status/Tygo-van-den-Hurk/Slyde/push--deploy-github-pages.yaml?style=flat&labelColor=2F363D&color=FF8C2B&logo=readthedocs&logoColor=FFFFFF&label=Docs&branch=main&event=push" alt="Website deployment Status" />
53+
</picture>
54+
</a>
55+
<a href="https://github.com/Tygo-van-den-Hurk/Slyde/actions/workflows/push--basic-ci-checks.yaml">
56+
<picture>
57+
<source srcset="https://img.shields.io/github/actions/workflow/status/Tygo-van-den-Hurk/Slyde/push--basic-ci-checks.yaml?style=flat&labelColor=FFFFFF&color=f9c262&logo=GitHub%20Actions&logoColor=000000&branch=main&event=push&label=Tests" media="(prefers-color-scheme: light)" />
58+
<img src="https://img.shields.io/github/actions/workflow/status/Tygo-van-den-Hurk/Slyde/push--basic-ci-checks.yaml?style=flat&labelColor=2F363D&color=FF8C2B&logo=GitHub%20Actions&logoColor=FFFFFF&branch=main&event=push&label=Tests" alt="Code coverage tests" />
59+
</picture>
60+
</a>
61+
<a href="https://github.com/Tygo-van-den-Hurk/Slyde/actions/workflows/many--build-and-push-image.yaml">
62+
<picture>
63+
<source srcset="https://img.shields.io/github/actions/workflow/status/Tygo-van-den-Hurk/Slyde/many--build-and-push-image.yaml?style=flat&labelColor=FFFFFF&color=f9c262&logo=docker&logoColor=000000&label=Docker&branch=main&event=push" media="(prefers-color-scheme: light)" />
64+
<img src="https://img.shields.io/github/actions/workflow/status/Tygo-van-den-Hurk/Slyde/many--build-and-push-image.yaml?style=flat&labelColor=2F363D&color=FF8C2B&logo=docker&logoColor=FFFFFF&label=Docker&branch=main&event=push" alt="Docker image building" />
65+
</picture>
66+
</a>
67+
<a href="https://github.com/Tygo-van-den-Hurk/Slyde/actions/workflows/many--publish-npm-package.yaml">
68+
<picture>
69+
<source srcset="https://img.shields.io/github/actions/workflow/status/Tygo-van-den-Hurk/Slyde/many--publish-npm-package.yaml?style=flat&labelColor=FFFFFF&color=f9c262&logo=npm&logoColor=000000&label=NPM&branch=main&event=push" media="(prefers-color-scheme: light)" />
70+
<img src="https://img.shields.io/github/actions/workflow/status/Tygo-van-den-Hurk/Slyde/many--build-and-push-image.yaml?style=flat&labelColor=2F363D&color=FF8C2B&logo=npm&logoColor=FFFFFF&label=NPM&branch=main&event=push" alt="NPM package building" />
71+
</picture>
72+
</a>
73+
</badges-container>
974
</div>
1075

1176
## What is Slyde?

0 commit comments

Comments
 (0)