push.rocks/smartlog
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(docs): Update README: expand documentation, examples and usage guides

Browse Source
This commit is contained in:
Jürgen Kunz
2025-09-01 10:32:59 +00:00
parent d1c05fb9ae
commit d502ab8cc9
3 changed files with 646 additions and 188 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
changelog.md
View File

@@ -1,5 +1,15 @@
# Changelog
## 2025-09-01 - 3.1.9 - fix(docs)
Update README: expand documentation, examples and usage guides
- Fully rewrote README to a comprehensive documentation page with badges, motivation and feature overview.
- Added Quick Start, detailed usage examples and code snippets for Smartlog, destinations, and custom destinations.
- Documented interactive console features (spinners, progress bars) including non-interactive fallbacks and configuration options.
- Expanded sections on built-in destinations (console, file, devtools, ClickHouse, receiver) with practical examples and env-driven configuration.
- Added integration examples (PM2, Docker), CLI usage, advanced features (context management, scoped logging, minimum log levels) and best practices.
- Included API reference pointers and contributing / license information.
## 2025-05-20 - 3.1.8 - fix(devDependencies)
Update devDependencies for tstest and Node types