diff --git a/README.md b/README.md index ed2865f63..b2fe42328 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ ![Dashboard-dark](https://github.com/user-attachments/assets/db875138-164f-453c-a75e-889f88747578) (yes, we have a light theme as well, but this looks better on readme.md) -Checkmate is an open source uptime manager, server & Docker monitoring tool used to track the operational status and performance of servers and websites. It regularly checks whether a server/website is accessible and performs optimally, providing real-time alerts and reports on the monitored services' availability, downtime, and response time. +Checkmate is an open source uptime manager, server & Docker monitoring tool used to track the operational status and performance of servers and websites. It regularly checks whether a server/website is accessible and performs optimally, providing real-time alerts and reports on the monitored services' availability, downtime, and response time. Checkmate also has an agent, called [Capture](https://github.com/bluewave-labs/capture), to retrieve data from remote servers. While Capture is not required to run Checkmate, it provides additional insigths about your servers' CPU, RAM, disk and temperature status. ## Demo @@ -35,21 +35,17 @@ We've just launched our [Discussions](https://github.com/bluewave-labs/bluewave- - Completely open source, deployable on your servers - Website monitoring +- Page speed monitoring +- Infrastructure monitoring (memory, disk usage, CPU performance etc) - requires [Capture](https://github.com/bluewave-labs/capture) +- Docker monitoring - Port monitoring - Ping monitoring - Incidents at a glance -- Page speed monitoring - E-mail notifications - Scheduled maintenance **Roadmap (short term):** -We are actively developing **infrastructure monitoring** features for Checkmate, which will include comprehensive monitoring of memory, disk usage, and CPU performance. Our goal is to build a lightweight agent that runs on Linux servers, continuously collecting and transmitting health metrics to Checkmate, where the data will be visualized for real-time insights. - -Additionally, we will introduce **Docker monitoring** to track the performance and health of containerized environments. - -**Roadmap (long term):** - - DNS monitoring - SSL monitoring - Status pages @@ -63,11 +59,14 @@ Additionally, we will introduce **Docker monitoring** to track the performance a ## Contributing -We love contributors. Here's how you can contribute: +We are known for our great relationship with outside contributors. Checkmate is a young project, but we already have 600+ stars and 30+ contributors from all over the world. The last thing you should do here is to be shy. + +Here's how you can contribute: - Check [Contributor's guideline](https://github.com/bluewave-labs/bluewave-uptime/blob/master/CONTRIBUTING.md). - Have a look at our Figma designs [here](https://www.figma.com/design/RPSfaw66HjzSwzntKcgDUV/Uptime-Genie?node-id=0-1&t=WqOFv9jqNTFGItpL-1). We encourage you to copy to your own Figma page, then work on it as it is read-only. - Open an issue if you believe you've encountered a bug +- Check for good-first-issue's if you are a newcomer - Make a pull request to add new features/make quality-of-life improvements/fix bugs.