Skip to content

Commit 77ff431

Browse files
committed
docs: remove emojis and em dashes, rewrite for clarity before public release
1 parent a1e6448 commit 77ff431

3 files changed

Lines changed: 10 additions & 10 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
- Modern, minimal, single-header main implementation.
99

1010
### Fixed
11-
- Thread shutdown is losslessbackground logging thread fully drains before logger destruction.
11+
- Thread shutdown is now completely lossless. The background logging thread always fully drains before the logger is destroyed.
1212

1313
---
1414
All changes will be documented in this file.

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Thank you for your interest in contributing!
88
3. **Write clear code** and **add tests** for any new behavior.
99
4. **Run all tests** (`g++ -std=c++17 -pthread -Iinclude tests/*.cpp && ./...`) before submitting.
1010
5. **Open a pull request** (PR) with a clear, descriptive title and summary.
11-
6. **Participate in code review**be responsive, constructive, and open!
11+
6. **Participate in code review. Please be responsive, constructive, and open!**
1212

1313
## Reporting Issues
1414
- Search for existing issues first.

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
1414
---
1515

16-
## 🚀 Why cLog++?
16+
## Why cLog++?
1717

1818
- **Zero Dependencies:** No `nlohmann/json`, no Boost, no external build systems. Just drop `include/` into your project.
1919
- **Blazing Fast:** Custom zero-allocation JSON serializer achieves **sub-microsecond** latency (see [Benchmarks](#-benchmarks)).
@@ -23,7 +23,7 @@
2323

2424
---
2525

26-
## 📦 Quick Start
26+
## Quick Start
2727

2828
### 1. Integration
2929
Simply copy the `include/` directory to your project.
@@ -63,7 +63,7 @@ g++ -std=c++17 -O3 -I./include main.cpp -o app -pthread
6363
6464
---
6565

66-
## 📊 Benchmarks
66+
## Benchmarks
6767

6868
**cLog++ is fast.** We benchmarked it against popular alternatives on modern hardware (MacBook Pro M1 Pro).
6969

@@ -78,7 +78,7 @@ g++ -std=c++17 -O3 -I./include main.cpp -o app -pthread
7878

7979
---
8080

81-
## Features
81+
## Features
8282

8383
- **Asynchronous & Synchronous:** Toggle modes easily with `Logger::Mode`.
8484
- **Safe Lifecycle:** Automatic background thread management and lossless shutdown.
@@ -91,7 +91,7 @@ g++ -std=c++17 -O3 -I./include main.cpp -o app -pthread
9191
9292
---
9393

94-
## 🛠️ Advanced Usage
94+
## Advanced Usage
9595

9696
<details>
9797
<summary><strong>Custom Output (Sinks)</strong></summary>
@@ -124,7 +124,7 @@ log.info("system.heartbeat"); // Ignored
124124

125125
---
126126

127-
## 🤝 Contributing
127+
## Contributing
128128

129129
We welcome contributions! Whether it's reporting a bug, suggesting a feature, or writing code.
130130

@@ -142,13 +142,13 @@ We welcome contributions! Whether it's reporting a bug, suggesting a feature, or
142142

143143
---
144144

145-
## 📄 License
145+
## License
146146

147147
MIT © [cLog++ Contributors](LICENSE).
148148

149149
---
150150

151-
> If you find cLog++ useful, please **[star the repository](https://github.com/mbn-code/cLogpp)**! It helps the project grow.
151+
> If you find cLog++ useful, please consider starring the repository on GitHub! It helps the project grow.
152152

153153
<details>
154154
<summary><strong>Note on AI Involvement</strong></summary>

0 commit comments

Comments
 (0)