chore: add missing documentation

README.md

@@ -98,6 +98,8 @@ import (
 Then initiate the theme the way that suits your needs.
 
 ```go
+// use an adaptive theme that switches between light and dark depending on the
+// terminal's color scheme
 variant := catppuccin.Adaptive(catppuccin.Latte, catppuccin.Mocha)
 log.SetStyles(catppuccin.New(variant))
 ```

internal/themes/themes.go

@@ -7,12 +7,15 @@ import (
 	"github.com/op/redlog/pkg/catppuccin"
 )
 
+// Themes contains all available themes.
 var Themes = []logtheme.Theme{
 	catppuccin.Theme,
 }
 
+// Default theme is catppuccin.
 var Default = catppuccin.Theme
 
+// ByName returns a theme by name.
 func ByName(name string) (logtheme.Theme, bool) {
 	for _, t := range Themes {
 		if strings.EqualFold(t.Name, name) {
@@ -22,6 +25,7 @@ func ByName(name string) (logtheme.Theme, bool) {
 	return logtheme.Theme{}, false
 }
 
+// VariantByName returns a variant of a theme by name.
 func VariantByName(t logtheme.Theme, name string) (logtheme.Variant, bool) {
 	for _, v := range t.Variants {
 		if strings.EqualFold(v.Name, name) {

pkg/catppuccin/theme.go

@@ -9,7 +9,7 @@ import (
 )
 
 // Theme consists of 4 beautiful pastel color palettes. The theme comes in one
-// light and three dark variants
+// light and three dark variants.
 var Theme = logtheme.New(
 	"Catppuccin",
 	newVariant(Adaptive(Latte, Mocha)),

redlog.go

@@ -8,7 +8,9 @@ import (
 )
 
 var (
-	ErrUnknownTheme   = errors.New("unknown theme")
+	// ErrUnknownTheme is returned when a theme could not found.
+	ErrUnknownTheme = errors.New("unknown theme")
+	// ErrUnknownVariant is returned when a theme variant could not found.
 	ErrUnknownVariant = errors.New("unknown variant")
 )