wneessen/go-mail
1
1
Fork 0
mirror of https://github.com/wneessen/go-mail.git synced 2024-11-21 21:30:50 +01:00
Code Issues Projects Releases Packages Wiki Activity

Improve package documentation and description

Browse source 
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.
This commit is contained in:
Winni Neessen 2024-10-05 11:06:46 +02:00
parent fa3c6f956e
commit 869e8db6c5
Signed by: wneessen
GPG key ID: 385AC9889632126E
1 changed files with 7 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc.go
View file

@ -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"