Add basic docs to adapters

adapter/console/console.go

@@ -1,6 +1,14 @@
 // (c) 2022 Jacek Olszak
 // This code is licensed under MIT license (see LICENSE for details)
 
+// Package console provides yala adapters capable of logging using simplified console logger. This logger is meant
+// to be used for development purposes only. It does not provide any knobs and switches. If you need customization, then
+// please use real production-ready logger like zap, logrus or zerolog with appropriate adapter.
+//
+// The format of message produced by console adapters is:
+//
+//		LEVEL message key=value key=value error=error
+//
 package console
 
 import (

adapter/glogadapter/glog.go

@@ -1,6 +1,7 @@
 // (c) 2022 Jacek Olszak
 // This code is licensed under MIT license (see LICENSE for details)
 
+// Package glogadapter provides yala adapter which leverages glog package (https://github.com/golang/glog).
 package glogadapter
 
 import (

adapter/logrusadapter/logrus.go

@@ -1,6 +1,7 @@
 // (c) 2022 Jacek Olszak
 // This code is licensed under MIT license (see LICENSE for details)
 
+// Package logrusadapter provides yala adapter which leverages logrus module (https://github.com/sirupsen/logrus).
 package logrusadapter
 
 import (

adapter/printer/printer.go

@@ -16,6 +16,7 @@ import (
 // This adapter prints fields and error in logfmt format. For example:
 //
 // 		message key=value error=message
+//
 type Adapter struct {
 	Printer Printer
 }

adapter/zapadapter/zapadapter.go

@@ -1,6 +1,7 @@
 // (c) 2022 Jacek Olszak
 // This code is licensed under MIT license (see LICENSE for details)
 
+// Package zapadapter provides yala adapter which leverages zap module (https://github.com/uber-go/zap).
 package zapadapter
 
 import (

adapter/zerologadapter/zerolog.go

@@ -1,6 +1,7 @@
 // (c) 2022 Jacek Olszak
 // This code is licensed under MIT license (see LICENSE for details)
 
+// Package zerologadapter provides yala adapter which leverages zerolog module (https://github.com/rs/zerolog).
 package zerologadapter
 
 import (

logger/logger.go

@@ -1,6 +1,8 @@
 // (c) 2022 Jacek Olszak
 // This code is licensed under MIT license (see LICENSE for details)
 
+// Package logger provides tiny structured logging abstraction or facade for various logging libraries, allowing the end
+// user to plug in the desired logging library in main.go.
 package logger
 
 import (