docs: add documentation for godoc

logrus.go

@@ -1,15 +1,29 @@
 package logrus
 
+// Fields type, used to pass to `WithFields`.
 type Fields map[string]interface{}
 
+// Level type
 type Level uint8
 
+// These are the different logging levels. You can set the logging level to log
+// on your instance of logger, obtained with `logrus.New()`.
 const (
+	// Panic level, highest level of severity. Logs and then calls panic with the
+	// message passed to Debug, Info, ...
 	Panic Level = iota
+	// Fatal level. Logs and then calls `os.Exit(1)`. It will exit even if the
+	// logging level is set to Panic.
 	Fatal
+	// Error level. Logs. Used for errors that should definitely be noted.
+	// Commonly used for hooks to send errors to an error tracking service.
 	Error
+	// Warn level. Non-critical entries that deserve eyes.
 	Warn
+	// Info level. General operational entries about what's going on inside the
+	// application.
 	Info
+	// Debug level. Usually only enabled when debugging. Very verbose logging.
 	Debug
 )