Skip to content

Open-source status page, incident response and uptime monitoring

🏷️ add badge (#797)

Thibault Le Ouay780f3fb88f9a
diff --git a/README.md b/README.md
index ff0156ca1..5f8b81569 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,13 @@
<h3 align="center">OpenStatus</h3>
- <p align="center"> The Open-Source synthetic and Real User Monitoring monitoring platform.
+ <p align="center">
+ <a href="https://status.openstatus.dev">
+ <img src='https://status.openstatus.dev/badge'>
+ </a>
+ </p>
+
+ <p align="center"> The Open-Source frontend performance monitoring platform.
<br />
<a href="https://www.openstatus.dev"><strong>Learn more Β»</strong></a>
<br />
@@ -19,20 +25,55 @@
## About OpenStatus πŸ“
-OpenStatus is open-source synthetic and real user monitoring platform with
-beautiful status page and incident management. We are building it publicly for
-everyone to see our progress. We believe great softwares are built this way.
+OpenStatus is open-source frontend monitoring plateform.
+
+- **Synthetic monitoring**: Monitor your website and APIs worldwide and receive
+ notifications when they are down or slow.
+- **Real User Monitoring**: Understand how your users are experiencing your
+ website with core web vitals metrics.
+
+## Recognitions πŸ†
-You can choose to host it yourself or use our hosted version at
-[openstatus.dev](https://www.openstatus.dev)
+<a href="https://trendshift.io/repositories/1780" target="_blank"><img src="https://trendshift.io/api/badge/repositories/1780" alt="openstatusHQ%2Fopenstatus | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
+
+<a href="https://news.ycombinator.com/item?id=37740870">
+ <img
+ alt="Featured on Hacker News"
+ src="https://hackerbadge.now.sh/api?id=37740870"
+ style="width: 250px; height: 55px;" width="250" height="55"
+ />
+</a>
## Contact us πŸ’Œ
-If you want to learn more about this project or have any questions, book a call
-with us or send us an email at [[email protected]](mailto:[email protected])
-<br/><br/>
+If you are interested in our enterprise plan or need special features, please
+email us at [[email protected]](mailto:[email protected]) or book a
+call<br/><br/>
<a href="https://cal.com/team/openstatus/30min"><img alt="Book us with Cal.com" src="https://cal.com/book-with-cal-dark.svg" /></a>
+## Roadmap πŸ—ΊοΈ
+
+Here's our [roadmap](https://openstatus.productlane.com/roadmap) feel free to
+contribute to it.
+
+## Contributing 🀝
+
+If you want to help us building the best status page and alerting system, you
+can check our
+[contributing guidelines](https://github.com/openstatusHQ/openstatus/blob/main/CONTRIBUTING.MD)
+
+### Top Contributors
+
+<a href="https://github.com/openstatushq/openstatus/graphs/contributors">
+ <img src="https://contrib.rocks/image?repo=openstatushq/openstatus" />
+</a>
+
+Made with [Contrib.rocks](https://contrib.rocks)
+
+### Stats
+
+![Alt](https://repobeats.axiom.co/api/embed/180eee159c0128f683a30f15f51ac35bdbd9fa44.svg "Repobeats analytics image")
+
## Built with πŸ› οΈ
- [Next.js](https://nextjs.org/)
@@ -128,26 +169,3 @@ Videos to better understand the OpenStatus codebase:
- [The code behind OpenStatus and how it uses Turbopack](https://youtube.com/watch?v=PYfSJATE8v8).
- [Drop Betterstack and go open source](https://www.youtube.com/watch?v=PKag0USy3eQ)
-
-## Roadmap πŸ—ΊοΈ
-
-Here's our [roadmap](https://openstatus.productlane.com/roadmap) feel free to
-contribute to it.
-
-## Contributing 🀝
-
-If you want to help us building the best status page and alerting system, you
-can check our
-[contributing guidelines](https://github.com/openstatusHQ/openstatus/blob/main/CONTRIBUTING.MD)
-
-### Top Contributors
-
-<a href="https://github.com/openstatushq/openstatus/graphs/contributors">
- <img src="https://contrib.rocks/image?repo=openstatushq/openstatus" />
-</a>
-
-Made with [Contrib.rocks](https://contrib.rocks)
-
-### Stats
-
-![Alt](https://repobeats.axiom.co/api/embed/180eee159c0128f683a30f15f51ac35bdbd9fa44.svg "Repobeats analytics image")
diff --git a/apps/docs/synthetic/features/status-page.mdx b/apps/docs/synthetic/features/status-page.mdx
index d770a3335..006497075 100644
--- a/apps/docs/synthetic/features/status-page.mdx
+++ b/apps/docs/synthetic/features/status-page.mdx
@@ -17,3 +17,24 @@ In order to create your status page, you need to create at least one monitor.
A status page is a public page that displays the status and performance of your
services. It shows the current status of your services and the history of
incidents.
+
+## Status Page Badge 🏷️
+
+You can embed the status page badge on your website or GitHub README to show the
+current status of your services.
+
+<a href="https://status.openstatus.dev">
+ <img src="https://status.openstatus.dev/badge" />
+</a>
+
+Copy the following code and paste it into your website or GitHub README:
+
+```html
+<img src="https://YOUR-SLUG.openstatus.dev/badge" />
+```
+
+If you want the dark version of the badge, you can use the following URL:
+
+```html
+<img src="https://YOUR-SLUG.openstatus.dev/badge?theme=dark" />
+```
diff --git a/apps/web/public/assets/changelog/status-page-badge.jpeg b/apps/web/public/assets/changelog/status-page-badge.jpeg
new file mode 100644
index 000000000..6380b07a6
Binary files /dev/null and b/apps/web/public/assets/changelog/status-page-badge.jpeg differ
diff --git a/apps/web/src/content/changelog/status-page-badge.mdx b/apps/web/src/content/changelog/status-page-badge.mdx
new file mode 100644
index 000000000..538aa7b75
--- /dev/null
+++ b/apps/web/src/content/changelog/status-page-badge.mdx
@@ -0,0 +1,20 @@
+---
+title: Status Page SVG Badge
+description: Easily integrate the status of your service everywhere.
+image: /assets/changelog/status-page-badge.jpeg
+publishedAt: 2024-05-02
+---
+
+We have added a new feature to embed the status of your service everywhere.
+
+Just copy the following code and paste it into your website or GitHub README:
+
+```html
+<img src="https://YOUR-SLUG.openstatus.dev/badge" />
+```
+
+And it will look like this:
+
+<a href="https://status.openstatus.dev">
+ <img src="https://status.openstatus.dev/badge" />
+</a>