From c2b7d1a959cdc91e2ccfe6ce8bdf89e9afe91009 Mon Sep 17 00:00:00 2001
From: "Gorkem Cetin (BWL)" <167266851+gorkem-bwl@users.noreply.github.com>
Date: Sat, 21 Dec 2024 13:41:35 -0500
Subject: [PATCH] Update README.md
---
README.md | 39 +++++++++++++++++++++------------------
1 file changed, 21 insertions(+), 18 deletions(-)
diff --git a/README.md b/README.md
index 370674a95..ee09de5aa 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,9 @@
**Checkmate is on [GitHub trending](https://github.com/trending) and #1 trending for JavaScript apps on Fri Dec 13th & 15th**
-
+**If you would like to support us, please consider giving it a β, think about contributing or providing feedback.**
+
+

@@ -13,32 +15,31 @@


-
An open source server monitoring application
+An open source server and infrastructure monitoring application
 -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 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. -We've run stress tests with 1000+ active monitors without any particular issues or performance bottlenecks. +Checkmate has ben stress tested with 1000+ active monitors without any particular issues or performance bottlenecks. -We **love** what we are building here, and learn a few things about Reactjs, Nodejs, MongoDB and Docker while building Checkmate. **If you would like to support us, please consider giving it a β, think about contributing or providing feedback.** Please note that we do not operate a monetary donation program, make money by deploying servers, or run a SaaS business. +We **love** what we are building here, and we contibuously learn a few things about Reactjs, Nodejs, MongoDB and Docker while building Checkmate. ## π¦ Demo -See [Checkmate](https://checkmate-demo.bluewavelabs.ca/) in action. The username is uptimedemo@demo.com and the password is Demouser1! +See [Checkmate](https://checkmate-demo.bluewavelabs.ca/) in action. The username is uptimedemo@demo.com and the password is Demouser1! (just a note that we update the demo server from time to time, so if it doesn't work for you, please ping us on Discussions channel). ## π User's guide -Usage instructions can be found [here](https://bluewavelabs.gitbook.io/checkmate). +Usage instructions can be found [here](https://bluewavelabs.gitbook.io/checkmate). It's still WIP and some of the information there might be outdated. Rest assured, we are doing our best! :) ## π οΈ Installation -See installation instructions in [Checkmate documentation portal](https://bluewavelabs.gitbook.io/checkmate/quickstart). Alternatively, you can also use [Coolify](https://coolify.io/) for a one click Docker deployment. +See installation instructions in [Checkmate documentation portal](https://bluewavelabs.gitbook.io/checkmate/quickstart). Alternatively, you can also use [Coolify](https://coolify.io/) for a one click Docker deployment. If you would like to monitor your server infrastructure, you'll need [Capture agent](https://github.com/bluewave-labs/capture). Capture repository also contains the installation instructions. ## π Questions & ideas @@ -61,7 +62,7 @@ If you have any questions, suggestions or comments, please use our [Discord chan - Global (distributed) uptime checking on Solana network - Status pages -- Better notification options +- Better notification options (think Discord, Telegram, Slack) - More configuration options - DNS monitoring - SSL monitoring @@ -81,10 +82,11 @@ If you have any questions, suggestions or comments, please use our [Discord chan - [MUI (React framework)](https://mui.com/) - [Node.js](https://nodejs.org/en) - [MongoDB](https://mongodb.com) +- Lots of other open source components! ## π€ Contributing -We pride ourselves on building strong connections with contributors at every level. Despite being a young project, Checkmate has already earned 1900 stars and attracted 35+ contributors from around the globe. So, donβt hold back β jump in, contribute and learn with us! +We pride ourselves on building strong connections with contributors at every level. Despite being a young project, Checkmate has already earned 2700 stars and attracted almost 40 contributors from around the globe. So, donβt hold back β jump in, contribute and learn with us! Here's how you can contribute: @@ -96,20 +98,21 @@ Here's how you can contribute: 5. Check for good-first-issue's if you are a newcomer. 6. Make a pull request to add new features/make quality-of-life improvements/fix bugs. - -