From cad092bc6bd25dc13f67197a45cbb7a9530aeeb8 Mon Sep 17 00:00:00 2001 From: Tola Leng Date: Mon, 28 Jul 2025 02:12:49 +0700 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=96=20Add=20sections=20for=20Project?= =?UTF-8?q?=20Status=20and=20Sponsorship=20to=20the=20README.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 57 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 34 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index aeef6ac..5640b43 100644 --- a/README.md +++ b/README.md @@ -64,26 +64,9 @@ CheckCle is an Open Source solution for seamless, real-time monitoring of full-s * โœ… x86_64 PCs, laptops, servers (amd64) * โœ… Modern Raspberry Pi 3/4/5 with (64-bit OS), Apple Silicon Macs (arm64) -### Install CheckCle using one of the options below. +### Install CheckCle using one of the following methods: - -1. CheckCle One-Click Installation - Just copy and run on terminal -```bash -curl -fsSL https://checkcle.io/install.sh | bash - -``` -2. Install with docker run. Just copy ready docker run command below -```bash -docker run -d \ - --name checkcle \ - --restart unless-stopped \ - -p 8090:8090 \ - -v /opt/pb_data:/mnt/pb_data \ - --ulimit nofile=4096:8192 \ - operacle/checkcle:latest - -``` -3. Install with Docker compose Configuration. +1. Install with Docker Compose Configuration (Recommended) ```bash version: '3.9' @@ -103,6 +86,18 @@ services: hard: 8192 ``` +2. Install with docker run. Just copy ready docker run command below +```bash +docker run -d \ + --name checkcle \ + --restart unless-stopped \ + -p 8090:8090 \ + -v /opt/pb_data:/mnt/pb_data \ + --ulimit nofile=4096:8192 \ + operacle/checkcle:latest + +``` + 3. Admin Web Management Default URL: http://0.0.0.0:8090 @@ -126,6 +121,23 @@ services: --- +## Sponsors +๐Ÿ™ We're incredibly thankful to our sponsors. Your contributions enable us to maintain infrastructure (hosting, domains), run tests, and continue developing valuable features. + +### ๐Ÿฅˆ Silver Uptime Ally + + + + + +### ๐Ÿงก Ping Supporter + + + + + +--- + ## ๐Ÿ‘ฅ Contributors Thank you for contributing and continuously making CheckCle better, you're awesome ๐Ÿซถ @@ -141,16 +153,15 @@ Here are some ways you can help improve CheckCle: - ๐ŸŒŸ **Suggest Features** โ€“ Have an idea? Start a [Discussion](https://github.com/operacle/checkcle/discussions) or open a Feature Request issue. - ๐Ÿ›  **Submit Pull Requests** โ€“ Improve the code, fix bugs, add features, or enhance the docs. - ๐Ÿ“ **Improve Documentation** โ€“ Even a typo fix helps! -- ๐ŸŒ **Spread the Word** โ€“ Star โญ the repo, share it on socials, and invite others to contribute! +- ๐ŸŒ **Spread the Word** โ€“ Star โญ the [CheckCle](https://github.com/operacle/checkcle.git) repo, share it on socials, and invite others to contribute! --- ## ๐ŸŒ Stay Connected - Website: [checkcle.io](https://checkcle.io) - Documentation: [docs.checkcle.io](https://docs.checkcle.io) -- GitHub Repository: โญ [CheckCle](https://github.com/operacle/checkcle.git) -- Discord: Join our community [@discord](https://discord.gg/xs9gbubGwX) -- X: [@tlengoss](https://x.com/tlengoss) +- Chat on Discord: Join our community [@discord](https://discord.gg/xs9gbubGwX) +- Follow us on X: [@checkcle_oss](https://x.com/checkcle_oss) ## ๐Ÿ“œ License