Skip to content

Commit b3e169e

Browse files
committed
docs: update README to enhance project description and highlight features of Peekaping as an alternative to Uptime Kuma
1 parent 92d3b67 commit b3e169e

File tree

1 file changed

+22
-9
lines changed

1 file changed

+22
-9
lines changed

README.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Peekaping 🚀
1+
# Peekaping - the best uptime kuma alternative
22

33
![License](https://img.shields.io/badge/license-MIT-blue.svg)
44
![Go](https://img.shields.io/badge/go-%23007d9c.svg?style=flat&logo=go&logoColor=white)
@@ -11,7 +11,7 @@
1111

1212
**A modern, self-hosted uptime monitoring solution**
1313

14-
Peekaping is a powerful, feature-rich uptime monitoring system similar to Uptime Kuma, built with Go and React. Monitor your websites, APIs, and services with real-time notifications, beautiful status pages, and comprehensive analytics.
14+
Peekaping is a uptime monitoring system built with Golang and React. You can monitor your websites, API and many more leveraging beautiful status pages, alert notifications.
1515

1616
🔗 Website **[peekaping.com](https://peekaping.com)**
1717

@@ -21,16 +21,27 @@ Peekaping is a powerful, feature-rich uptime monitoring system similar to Uptime
2121

2222
🔗 Community terraform provider **[registry.terraform.io/providers/tafaust/peekaping](https://registry.terraform.io/providers/tafaust/peekaping/latest)**
2323

24+
## Why Peekaping Is the Best Alternative to Uptime Kuma
25+
26+
- API first architecture
27+
- easy to extend server architecture
28+
- Server written in golang that make it fast and lightweight using minimum RAM and CPU
29+
- high stability thanks to typed client and compiled golang
30+
- clean and modern ui design
31+
- flexible storage options: SQLite / PostgreSQL / MongoDB
32+
- API keys management and access control
33+
2434
## ⚠️ Beta Status
2535

26-
**Peekaping is currently in beta and actively being developed.** While I am excited to share this project with the community, please note that:
36+
**Peekaping is currently in beta and actively being developed.**
37+
Please note:
2738

28-
- The software is still undergoing testing and refinement
29-
- Some features may be incomplete or subject to change
39+
- The software is still under active development
40+
- Some features could be changed
3041
- I recommend testing in non-production environments first
3142
- Please report any issues you encounter - your feedback helps us improve!
3243

33-
We encourage you to try Peekaping and provide feedback, but please use it at your own discretion. Your testing and feedback are invaluable to making Peekaping production-ready! 🚀
44+
Please try Peekaping and provide feedback, this is huge contribution for us! Let's make Peekaping production ready.
3445

3546
## Quick start (docker + SQLite)
3647

@@ -101,11 +112,13 @@ Peekaping also support [PostgreSQL Setup](https://docs.peekaping.com/self-hostin
101112
- Brute-Force Login Protection
102113
- SSL Certificate Expiration Checks
103114

104-
## 💡 Motivation
115+
## 💡 Motivation behind creating uptime kuma alternative
116+
117+
Peekaping was deeply inspired by Uptime Kuma. We tried to cover all the fundamental flaws of Uptime Kuma. Alternative was to build new system with features community love and request but using typed approaches applying extendable architecture. First of all - we are API first. Our server side written in Golang, fast and efficient language that works with minimal RAM. Architecture allows easily extend system adding new notification channels, monitor types etc.
105118

106-
Peekaping is designed as a modern alternative to Uptime Kuma, built with a focus on **strongly typed architecture** and **extensibility**. Our server is written in Go, a fast and efficient language that enables a small footprint while maintaining high performance. The codebase is structured for easy extensibility, allowing developers to seamlessly add new notification channels, monitor types, and even swap out the database layer without major refactoring.
119+
Client side written with React and typescript that makes it reliable and fast. Client side is also easily extensible.
107120

108-
The client-side application is also strongly typed and built with modern React patterns, making it equally extensible and maintainable. This combination of type safety, performance, and modular design makes Peekaping an ideal choice for teams who need a reliable, customizable uptime monitoring solution.
121+
Peekaping an ideal choice for teams who need a reliable, customizable uptime monitoring solution.
109122

110123
![Peekaping Dashboard](./pictures/monitor.png)
111124

0 commit comments

Comments
 (0)