Improve documentation

Author: louisroyer

ginlogger/doc.go

@@ -3,5 +3,5 @@
 // found in the LICENSE file.
 // SPDX-License-Identifier: MIT
 
-// Package ginlogger provide gin gonic middleware to use logrus as logger.
+// Package ginlogger provide [github.com/gin-gonic/gin] middleware to use [github.com/sirupsen/logrus] as logger.
 package ginlogger

ginlogger/ginlogger.go

@@ -10,7 +10,7 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
-// LoggingMiddleware is a gin gonic middleware to use logrus for logging
+// LoggingMiddleware is a [gin.HandlerFunc] to use [logrus] as logger
 func LoggingMiddleware(ctx *gin.Context) {
 	ctx.Next()
 	method := ctx.Request.Method

ginlogger/ginlogger_test.go

@@ -6,8 +6,9 @@
 package ginlogger_test
 
 import (
-	"github.com/gin-gonic/gin"
 	"github.com/nextmn/logrus-formatter/ginlogger"
+
+	"github.com/gin-gonic/gin"
 )
 
 func ExampleLoggingMiddleware() {

logger/doc.go

@@ -0,0 +1,9 @@
+// Copyright Louis Royer and the NextMN contributors. All rights reserved.
+// Use of this source code is governed by a MIT-style license that can be
+// found in the LICENSE file.
+// SPDX-License-Identifier: MIT
+
+// Package logger provide a [github.com/sirupsen/logrus] formatter to be used by the [NextMN] project.
+//
+// [NextMN]: https://github.com/NextMN
+package logger

logger/logger.go

@@ -49,7 +49,8 @@ func newLogFormatter() *logFormatter {
 	}
 }
 
-func Init(prefix string) {
+// Init [logrus] with the logger formatter.
+func Init(appName string) {
 	logrus.SetFormatter(newLogFormatter())
-	logrus.AddHook(newHook(prefix))
+	logrus.AddHook(newHook(appName))
 }

logger/logger_test.go

@@ -0,0 +1,19 @@
+// Copyright Louis Royer and the NextMN contributors. All rights reserved.
+// Use of this source code is governed by a MIT-style license that can be
+// found in the LICENSE file.
+// SPDX-License-Identifier: MIT
+
+package logger_test
+
+import (
+	"github.com/nextmn/logrus-formatter/logger"
+
+	"github.com/sirupsen/logrus"
+)
+
+func ExampleInit() {
+	appName := "foo"     // name of the application
+	logger.Init(appName) // init the logrus formatter
+	// ...
+	logrus.Info("An event occurred")
+}