Updated README.md

This commit is contained in:
Winni Neessen 2022-03-14 10:33:15 +01:00
parent 1157180369
commit bc9b55de89
Signed by: wneessen
GPG key ID: 385AC9889632126E

View file

@ -6,15 +6,14 @@ The main idea of this library was to provide a simple interface to sending mails
my [JS-Mailer](https://github.com/wneessen/js-mailer) project. It quickly evolved into a my [JS-Mailer](https://github.com/wneessen/js-mailer) project. It quickly evolved into a
full-fledged mail library. full-fledged mail library.
Parts of this library (especially some parts of [msgwriter.go](msgwriter.go)) have been forked/ported from the
[GoMail](https://github.com/go-mail/mail) which seems to not be maintained anymore.
**This library is "WIP" an should not be considered "production ready", yet.**
go-mail follows idiomatic Go style and best practice. It's only dependency is the Go Standard Library. go-mail follows idiomatic Go style and best practice. It's only dependency is the Go Standard Library.
It combines a lot of functionality from the standard library to give easy and convenient access to It combines a lot of functionality from the standard library to give easy and convenient access to
mail and SMTP related tasks. mail and SMTP related tasks.
Parts of this library (especially some parts of [msgwriter.go](msgwriter.go)) have been forked/ported from the
[go-mail/mail](https://github.com/go-mail/mail) respectively [go-gomail/gomail](https://github.com/go-gomail/gomail)
which both seems to not be maintained anymore.
## Features ## Features
Some of the features of this library: Some of the features of this library:
* [X] Only Standard Library dependant * [X] Only Standard Library dependant
@ -31,5 +30,5 @@ Some of the features of this library:
* [ ] Support for different encodings * [ ] Support for different encodings
## Examples ## Examples
The packageis shipped with example code. Check it out on the packages The package is shipped with example code. Check it out on the packages
[GoDoc page](https://pkg.go.dev/github.com/wneessen/go-mail#pkg-examples) [GoDoc page](https://pkg.go.dev/github.com/wneessen/go-mail#pkg-examples)