From 6da52adc7444e9970e60a8b2315d206cc7f228fe Mon Sep 17 00:00:00 2001 From: "Gorkem Cetin (BWL)" <167266851+gorkem-bwl@users.noreply.github.com> Date: Wed, 23 Jul 2025 15:41:44 -0400 Subject: [PATCH] Trying to fix anchors --- README.md | 45 ++++++++++++++++++++++----------------------- 1 file changed, 22 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 4be16fef0..d584d832d 100644 --- a/README.md +++ b/README.md @@ -26,41 +26,40 @@ Checkmate has been stress-tested with 1000+ active monitors without any particul ## πŸ“š Table of contents -- [πŸ“¦ Demo](#-demo) -- [πŸ”— User's guide](#-users-guide) -- [πŸ› οΈ Installation](#️-installation) -- [πŸš€ Deploying Checkmate with Helm](#-deploying-checkmate-with-helm) -- [🏁 Translations](#-translations) -- [πŸš€ Performance](#-performance) -- [πŸ’š Questions & Ideas](#-questions--ideas) -- [🧩 Features](#-features) -- [πŸ—οΈ Screenshots](#-screenshots) -- [πŸ—οΈ Tech stack](#-tech-stack) +- [πŸ“¦ Demo](#demo) +- [πŸ”— User's guide](#users-guide) +- [πŸ› οΈ Installation](#installation) +- [🏁 Translations](#translations) +- [πŸš€ Performance](#performance) +- [πŸ’š Questions & Ideas](#questions--ideas) +- [🧩 Features](#features) +- [πŸ—οΈ Screenshots](#screenshots) +- [πŸ—οΈ Tech stack](#tech-stack) - [πŸ”— A few links](#a-few-links) -- [🀝 Contributing](#-contributing) -- [πŸ’° Our sponsors](#-our-sponsors) +- [🀝 Contributing](#contributing) +- [πŸ’° Our sponsors](#our-sponsors) -## πŸ“¦ Demo +## Demo You can see the latest build of [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 the Discussions channel). -## πŸ”— User's guide +## User's guide Usage instructions can be found [here](https://docs.checkmate.so/checkmate-2.1). It's still WIP and some of the information there might be outdated as we continuously add features weekly. Rest assured, we are doing our best! :) -## πŸ› οΈ Installation +## Installation See installation instructions in [Checkmate documentation portal](https://docs.checkmate.so/checkmate-2.1/users-guide/quickstart). Alternatively, you can also use [Coolify](https://coolify.io/), [Elestio](https://elest.io/open-source/checkmate), [K8s](./charts/helm/checkmate/INSTALLATION.md) or [Pikapods](https://www.pikapods.com/) to quickly spin off a Checkmate instance. 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. -## 🏁 Translations +## Translations If you would like to use Checkmate in your language, please [go to this page](https://poeditor.com/join/project/lRUoGZFCsJ) and register for the language you would like to translate Checkmate to. -## πŸš€ Performance +## Performance Thanks to extensive optimizations, Checkmate operates with an exceptionally small memory footprint, requiring minimal memory and CPU resources. Here’s the memory usage of a Node.js instance running on a server that monitors 323 servers every minute: @@ -70,7 +69,7 @@ You can see the memory footprint of MongoDB and Redis on the same server (398Mb ![image](https://github.com/user-attachments/assets/3b469e85-e675-4040-a162-3f24c1afc751) -## πŸ’š Questions & Ideas +## Questions & Ideas If you have any questions, suggestions or comments, you have several options: @@ -80,7 +79,7 @@ If you have any questions, suggestions or comments, you have several options: Feel free to ask questions or share your ideas - we'd love to hear from you! -## 🧩 Features +## Features - Completely open source, deployable on your servers or home devices (e.g Raspberry Pi 4 or 5) - Website monitoring @@ -103,7 +102,7 @@ Feel free to ask questions or share your ideas - we'd love to hear from you! - Network monitoring - ..and a few more features -## πŸ—οΈ Screenshots +## Screenshots

image @@ -120,7 +119,7 @@ Feel free to ask questions or share your ideas - we'd love to hear from you! -## πŸ—οΈ Tech stack +## Tech stack - [ReactJs](https://react.dev/) - [MUI (React framework)](https://mui.com/) @@ -136,7 +135,7 @@ Feel free to ask questions or share your ideas - we'd love to hear from you! - Need a ping when there's a new release? Use [Newreleases](https://newreleases.io/), a free service to track releases. - Watch a Checkmate [installation and usage video](https://www.youtube.com/watch?v=GfFOc0xHIwY) -## 🀝 Contributing +## Contributing We are [Alex](http://github.com/ajhollid) (team lead), [Vishnu](http://github.com/vishnusn77), [Mohadeseh](http://github.com/mohicody), [Gorkem](http://github.com/gorkem-bwl/), [Owaise](http://github.com/Owaiseimdad), [Aryaman](https://github.com/Br0wnHammer) and [Mert](https://github.com/mertssmnoglu) helping individuals and businesses monitor their infra and servers. @@ -160,7 +159,7 @@ Here's how you can contribute: [![Star History Chart](https://api.star-history.com/svg?repos=bluewave-labs/checkmate&type=Date)](https://star-history.com/#bluewave-labs/bluewave-uptime&Date) -## πŸ’° Our sponsors +## Our sponsors Thanks to [Gitbook](https://gitbook.io/) for giving us a free tier for their documentation platform, and [Poeditor](https://poeditor.com/) providing us a free account to use their i18n services. If you would like to sponsor Checkmate, please send an email to hello@bluewavelabs.ca