preparing for 1.0
This commit is contained in:
parent
28d0d041b0
commit
31c9ed52cb
14
LICENSE
Normal file
14
LICENSE
Normal file
@ -0,0 +1,14 @@
|
||||
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
|
||||
Version 2, December 2004
|
||||
|
||||
Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim or modified
|
||||
copies of this license document, and changing it is allowed as long
|
||||
as the name is changed.
|
||||
|
||||
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. You just DO WHAT THE FUCK YOU WANT TO.
|
||||
|
15
README.md
15
README.md
@ -11,15 +11,18 @@ stdlib `log/slog` default handler, and solve the 90% case for logging.
|
||||
|
||||
## Current Status
|
||||
|
||||
Pre-1.0, not working yet.
|
||||
Released v1.0.0 2024-06-14. Works as intended. No known bugs.
|
||||
|
||||
## Features
|
||||
|
||||
- if output is a tty, outputs pretty color logs
|
||||
- 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
|
||||
|
||||
## Planned Features
|
||||
|
||||
- supports delivering logs via tcp RELP (e.g. to remote rsyslog using imrelp)
|
||||
|
||||
## Installation
|
||||
|
||||
To use simplelog, first ensure your project is set up with Go modules:
|
||||
@ -36,7 +39,9 @@ go get sneak.berlin/go/simplelog
|
||||
|
||||
## 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
|
||||
package main
|
||||
@ -54,3 +59,7 @@ func main() {
|
||||
slog.Error("Failed to save data", slog.String("reason", "permission denied"))
|
||||
}
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
[WTFPL](./LICENSE)
|
||||
|
Loading…
Reference in New Issue
Block a user