Skip to content

Commit 060972b

Browse files
author
Omer Bulut
committed
feat: enhance README.md with badges and quick start section
- Add CI/CD pipeline badge - Add version, license, C++, platform badges - Add tests passing badge - Add quick start section with one-liner installation - Add live demo code example - Prepare for Docker support
1 parent aff0bf4 commit 060972b

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# πŸš€ FreshLogger - Enterprise-Grade C++ Logging Library
22

3+
[![CI/CD Pipeline](https://github.com/omerrbbulut/FreshLogger/workflows/FreshLogger%20CI%2FCD%20Pipeline/badge.svg)](https://github.com/omerrbbulut/FreshLogger/actions)
4+
[![Version](https://img.shields.io/badge/version-1.3.0-blue.svg)](https://github.com/omerrbbulut/FreshLogger/releases)
5+
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
6+
[![C++](https://img.shields.io/badge/C%2B%2B-17-blue.svg)](https://isocpp.org/)
7+
[![Platform](https://img.shields.io/badge/platform-Linux%20%7C%20macOS-blue.svg)](https://github.com/omerrbbulut/FreshLogger)
8+
[![Tests](https://img.shields.io/badge/tests-100%25%20passing-brightgreen.svg)](https://github.com/omerrbbulut/FreshLogger/actions)
9+
310
A high-performance, feature-rich C++ logging library with comprehensive CI/CD pipeline and enterprise-grade testing.
411

512
## ✨ Features
@@ -36,6 +43,34 @@ A high-performance, feature-rich C++ logging library with comprehensive CI/CD pi
3643
- πŸ”„ **Integration Tests**: Real-world scenario testing
3744
- πŸ”„ **Load Testing**: High concurrency testing
3845

46+
## ⚑ Quick Start
47+
48+
### πŸš€ One-Liner Installation
49+
```bash
50+
# Clone and run in one command
51+
git clone https://github.com/omerrbbulut/FreshLogger.git && cd FreshLogger && make all && make enterprise-test
52+
```
53+
54+
### πŸ“¦ Docker Support (Coming Soon)
55+
```bash
56+
# Docker image will be available soon
57+
docker pull omerrbbulut/freshlogger:latest
58+
```
59+
60+
### 🎯 Live Demo
61+
```cpp
62+
#include "Logger.hpp"
63+
64+
int main() {
65+
Logger logger;
66+
logger.info("πŸš€ FreshLogger is running!");
67+
logger.debug("Debug mode enabled");
68+
logger.warning("This is a warning");
69+
logger.error("This is an error");
70+
return 0;
71+
}
72+
```
73+
3974
## πŸ“¦ Installation
4075

4176
### Prerequisites

0 commit comments

Comments
Β (0)