From dcd963a740dcdc205cf820610777659b08d67986 Mon Sep 17 00:00:00 2001
From: "Gustavo L de Mello (Guz)" <contact@guz.one>
Date: Mon, 27 Jan 2025 19:02:36 -0300
Subject: [PATCH] docs(blogo): New function documentation

---
 blogo/blogo.go | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/blogo/blogo.go b/blogo/blogo.go
index 104b364..01275f2 100644
--- a/blogo/blogo.go
+++ b/blogo/blogo.go
@@ -36,6 +36,14 @@ var defaultInternalErrTemplate = template.Must(
 		Parse("500: Failed to get blog post {{.Path}} due to error {{.ErrorMsg}}\n{{.Error}}"),
 )
 
+// The main function of the package. Creates a new [Blogo] implementation.
+//
+// This implementation automatically adds fallbacks and uses built-in [plugins] to handle
+// multiple sources, renderers and error handlers.
+//
+// Use [Opts] to more fine grained control of what plugins are used on initialization. To have
+// complete control over how plugins are managed, use the [core] package and [plugins]
+// for more information and building blocks to create a custom [Blogo] implementation.
 func New(opts ...Opts) Blogo {
 	opt := Opts{}
 	if len(opts) > 0 {