Skip to content

Commit 9a441a6

Browse files
committed
β˜• chore: update README for markdown linting
1 parent 2ab4cb5 commit 9a441a6

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ Log Engine transforms your development experience from chaotic debugging session
2727
- **Easy Integration**: Simple API that works seamlessly with existing Node.js applications. Just `import` and start logging - no middleware, plugins, or configuration required.
2828

2929
## πŸ€” How It Works
30-
30+
<!-- markdownlint-disable MD051 -->
3131
1. Log Engine automatically detects your environment using `NODE_ENV` and sets appropriate log levels for optimal performance
3232
2. When you call logging methods, messages are filtered based on the configured severity level (only messages at or above the set level are displayed)
3333
3. Each log message is instantly formatted with precise timestamps in both ISO and human-readable formats
3434
4. Messages are output to the console with **colorized level indicators and timestamps**, making debugging and monitoring effortless - errors show in red, warnings in yellow, info in blue, and debug in purple
3535
5. ANSI color codes ensure compatibility across different terminal environments while maintaining beautiful, readable output
3636

3737
Ready to streamline your application logging? Get started in seconds with our [simple installation](#πŸ“¦-installation)!
38-
38+
<!-- markdownlint-enable MD051 -->
3939
## πŸ€— Special Thanks
4040

4141
<!-- markdownlint-disable MD033 -->
@@ -148,13 +148,14 @@ Log messages are beautifully formatted with colorized timestamps, levels, and sm
148148

149149
```bash
150150
# Example colorized output (colors visible in terminal)
151-
[2025-05-29T16:57:45.678Z] [4:57 PM] [DEBUG]: Debugging application flow
152-
[2025-05-29T16:57:46.123Z] [4:57 PM] [INFO]: Server started successfully
153-
[2025-05-29T16:57:47.456Z] [4:57 PM] [WARN]: API rate limit approaching
154-
[2025-05-29T16:57:48.789Z] [4:57 PM] [ERROR]: Database connection failed
151+
[2025-05-29T16:57:45.678Z][4:57 PM][DEBUG]: Debugging application flow
152+
[2025-05-29T16:57:46.123Z][4:57 PM][INFO]: Server started successfully
153+
[2025-05-29T16:57:47.456Z][4:57 PM][WARN]: API rate limit approaching
154+
[2025-05-29T16:57:48.789Z][4:57 PM][ERROR]: Database connection failed
155155
```
156156

157157
**Color Scheme:**
158+
158159
- 🟣 **DEBUG**: Magenta/Purple - Detailed debugging information
159160
- πŸ”΅ **INFO**: Blue - General informational messages
160161
- 🟑 **WARN**: Yellow - Warning messages that need attention
@@ -176,11 +177,12 @@ Join our community discussions to get help, share ideas, and connect with other
176177
### Getting Help
177178

178179
Need assistance with the library? Here's how to get help:
179-
180+
<!-- markdownlint-disable MD051 -->
180181
- **Community Support**: Check the [Help & Support](https://github.com/wgtechlabs/log-engine/discussions/categories/help-support) category in our GitHub Discussions for answers to common questions.
181182
- **Ask a Question**: Create a [new discussion](https://github.com/wgtechlabs/log-engine/discussions/new?category=help-support) if you can't find answers to your specific issue.
182183
- **Documentation**: Review the [usage instructions](#πŸ•ΉοΈ-usage) in this README for common examples and configurations.
183184
- **Known Issues**: Browse [existing issues](https://github.com/wgtechlabs/log-engine/issues) to see if your problem has already been reported.
185+
<!-- markdownlint-enable MD051 -->
184186

185187
### Reporting Issues
186188

0 commit comments

Comments
Β (0)