diff --git a/.all-contributorsrc b/.all-contributorsrc deleted file mode 100644 index 056cf39..0000000 --- a/.all-contributorsrc +++ /dev/null @@ -1,26 +0,0 @@ -{ - "files": [ - "README.md" - ], - "imageSize": 100, - "commit": false, - "commitType": "docs", - "commitConvention": "angular", - "contributors": [ - { - "login": "kaedeek", - "name": "โ‚–โ‚โ‚‘๐’นโ‚‘", - "avatar_url": "https://avatars.githubusercontent.com/u/170544738?v=4", - "profile": "https://github.com/kaedeek", - "contributions": [ - "code" - ] - } - ], - "contributorsPerLine": 7, - "skipCi": true, - "repoType": "github", - "repoHost": "https://github.com", - "projectName": "VersaLog.go", - "projectOwner": "kayu0514" -} diff --git a/README.md b/README.md index d210669..31a2cce 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,5 @@ # What is VersaLog.go? - - -[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) - - - [![Go Version](https://img.shields.io/badge/go-%3E%3D1.19-blue.svg)](https://golang.org/) [![Go Report Card](https://goreportcard.com/badge/github.com/VersaLog/VersaLog.go)](https://goreportcard.com/report/github.com/VersaLog/VersaLog.go) [![Go Reference](https://pkg.go.dev/badge/github.com/VersaLog/VersaLog.go.svg)](https://pkg.go.dev/github.com/VersaLog/VersaLog.go) @@ -15,6 +9,66 @@ What is VersaLog.go? VersaLog is a powerful and flexible logging library for Golang. It supports everything from simple usage to advanced, highly customizable configurations to meet a wide range of needs. +## Feature + +### Basic Logging + +- Supports standard log levels: + - `INFO`, `ERROR`, `WARNING`, `DEBUG`, `CRITICAL` +- Colored output for better readability +- Symbol-based prefixes (e.g. `[+]`, `[-]`, `[!]`) + +### Multiple Output Formats + +**Easily switch between different log styles:** + +- `simple` โ†’ `[+] message` +- `simple2` โ†’ `[TIME] [+] message` +- `detailed` โ†’ `[TIME][LEVEL] : message` +- `file` โ†’ `[FILE:LINE][LEVEL] message` + +### Tag System + +- Add custom tags to logs +- Supports multiple tags (e.g. `["API", "AUTH"]`) +- Optional default tags + +### File & Line Tracking + +- Display caller file name and line number +- Useful for debugging large projects + +### Log File Saving + +- Automatically save logs to files +- Output path: `./log/YYYY-MM-DD.log` +- Select which log levels to save + +### Auto Cleanup + +- Automatically deletes old log files (default: 7 days) +- Keeps your log directory clean + +### Auto Cleanup + +- Disable console output +- Useful for background services + +### Exception Handling + +- Automatically captures unhandled exceptions +- Logs them as `CRITICAL` + +### Desktop Notifications + +- Optional desktop alerts for errors and critical logs +- Uses `plyer.notification` + +### Asynchronous Logging + +- Non-blocking log processing using threads and queues +- Improves performance in high-load environments + ## Support Join our Discord server for support, questions, and community discussions: @@ -72,26 +126,4 @@ logger := versalog.NewVersaLog( ``` [2025-08-06 04:10:36][INFO] : ok -``` - -## Contributors โœจ - -Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): - - - - - - - - - - -
โ‚–โ‚โ‚‘๐’นโ‚‘
โ‚–โ‚โ‚‘๐’นโ‚‘

๐Ÿ’ป
- - - - - - -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! +``` \ No newline at end of file