From 31c9ed52cb8f68d690dc57caecc1b8f7a0e5f0bc Mon Sep 17 00:00:00 2001 From: sneak Date: Fri, 14 Jun 2024 05:49:21 -0700 Subject: [PATCH] preparing for 1.0 --- LICENSE | 14 ++++++++++++++ README.md | 15 ++++++++++++--- 2 files changed, 26 insertions(+), 3 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ee7d6a5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,14 @@ + DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE + Version 2, December 2004 + + Copyright (C) 2004 Sam Hocevar + + 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. + diff --git a/README.md b/README.md index bbec684..3f6222e 100644 --- a/README.md +++ b/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)