sneak
/
simplelog
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

preparing for 1.0

This commit is contained in:
Jeffrey Paul 2024-06-14 05:49:21 -07:00
parent 28d0d041b0
commit eb44182651
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -11,15 +11,18 @@ stdlib `log/slog` default handler, and solve the 90% case for logging.
## Current Status ## Current Status
Pre-1.0, not working yet. Released v1.0.0 2024-06-14. Works as intended. No known bugs.
## Features ## Features
- if output is a tty, outputs pretty color logs - if output is a tty, outputs pretty color logs
- if output is not a tty, outputs json - if output is not a tty, outputs json
- supports delivering logs via tcp RELP (e.g. to remote rsyslog using imrelp)
- supports delivering each log message via a webhook - supports delivering each log message via a webhook
## Planned Features
- supports delivering logs via tcp RELP (e.g. to remote rsyslog using imrelp)
## Installation ## Installation
To use simplelog, first ensure your project is set up with Go modules: To use simplelog, first ensure your project is set up with Go modules:
@ -36,7 +39,9 @@ go get sneak.berlin/go/simplelog
## Usage ## Usage
Below is an example of how to use SimpleLog in a Go application. This example is provided in the form of a `main.go` file, which demonstrates logging at various levels using structured logging syntax. Below is an example of how to use SimpleLog in a Go application. This
example is provided in the form of a `main.go` file, which demonstrates
logging at various levels using structured logging syntax.
```go ```go
package main package main