diff --git a/README.md b/README.md index 8ca8e57..48d6461 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,9 @@ import "code.nochebuena.dev/einherjar/smtp" mailer := smtp.New(logger, smtp.DefaultConfig()) -launcher.Append(mailer) // OnInit verifies credentials; OnStop is a no-op -health.Register(mailer) // dial check; LevelDegraded +lc.Append(mailer) // OnInit verifies credentials; OnStop is a no-op +// mailer is observability.Checkable (dial check, LevelDegraded): +srv.Get("/health", health.NewHandler(logger, mailer).ServeHTTP) ``` When `cfg.Host` is empty, `New` returns a no-op that logs every `Send` call at debug level and always returns nil. No code changes are needed between environments. diff --git a/doc.go b/doc.go index f1c67c7..6e2c3de 100644 --- a/doc.go +++ b/doc.go @@ -12,8 +12,12 @@ // # Lifecycle Registration // // client := smtp.New(logger, cfg) -// launcher.Register(client) -// health.Register(client) +// lc.Append(client) // lifecycle: OnInit → OnStop +// +// client satisfies [observability.Checkable], so it can back a health endpoint via +// web/health.NewHandler: +// +// srv.Get("/health", health.NewHandler(logger, client).ServeHTTP) // // # Sending //