From 869e8db6c566ccf55dde2f1932ddebcf6b50feb7 Mon Sep 17 00:00:00 2001 From: Winni Neessen Date: Sat, 5 Oct 2024 11:06:46 +0200 Subject: [PATCH] Improve package documentation and description Expand the package mail description to highlight ease of use, reliance on the Go Standard Library, and added functionalities. Clarify the role of VERSION in the user agent string. --- doc.go | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/doc.go b/doc.go index 831a57c..de16f5d 100644 --- a/doc.go +++ b/doc.go @@ -2,8 +2,13 @@ // // SPDX-License-Identifier: MIT -// Package mail provides a simple and easy way to send mails with Go +// Package mail provides an easy to use interface for formating and sending mails. go-mail follows idiomatic Go style +// and best practice. It has a small dependency footprint by mainly relying on the Go Standard Library and the Go +// extended packages. It combines a lot of functionality from the standard library to give easy and convenient access +// to mail and SMTP related tasks. It works like a programatic email client and provides lots of methods and +// functionalities you would consider standard in a MUA. package mail -// VERSION is used in the default user agent string +// VERSION indicates the current version of the package. It is also attached to the default user +// agent string. const VERSION = "0.4.4"