feat: update screenshots and some documentation (#9)

Author: akfaiz

README.md

@@ -7,16 +7,17 @@
 [![Go Version](https://img.shields.io/github/go-mod/go-version/ahmadfaizk/go-mailgen)](https://golang.org/doc/devel/release.html)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
 
+<div align="center"><img src="./logo.png" width="150" alt="go-mailgen logo"/></div>
+
 **Go-Mailgen** is a Go library for generating professional HTML emails using a fluent, intuitive API. Simplify email creation with customizable templates and seamless integration into your Go applications. This project is inspired by the [mailgen](https://github.com/eladnava/mailgen) Node.js package, bringing its elegant email generation approach to the Go ecosystem.
 
 ## Features
 
 - **Fluent API**: Build emails with a clean, chainable interface.
 - **Inline CSS**: Ensures compatibility across major email clients.
-- **Template-Based**: Use pre-built or custom templates for rapid development.
 - **Easy Integration**: Works effortlessly with popular Go mail libraries like go-mail.
 - **Chainable Methods**: Add content, actions, and tables in a straightforward manner.
-- **Global Configuration**: Set default sender, product information, and theme for all emails.
+- **Global Configuration**: Set default base email settings and themes.
 
 ## Installation
 
@@ -54,7 +55,7 @@ func main() {
 		From("no-reply@example.com", "Go-Mailgen").
 		Product(mailgen.Product{
 			Name: "Go-Mailgen",
-			URL:  "https://github.com/ahmadfaizk/go-mailgen",
+			Link: "https://github.com/ahmadfaizk/go-mailgen",
 		}).
 		Theme("default"),
 	)
@@ -89,6 +90,7 @@ func main() {
 You can find more examples in the [examples](examples) directory.
 
 ## Documentation
+
 For detailed documentation, please visit the [Go-Mailgen documentation](https://pkg.go.dev/github.com/ahmadfaizk/go-mailgen).
 
 ## Supported Themes
@@ -97,11 +99,31 @@ The following open-source themes are bundled with this package:
 
 - `default` by [Postmark Transactional Email Templates](https://github.com/ActiveCampaign/postmark-templates)
 
-<img src="examples/default/welcome.png" height="200" /> <img src="examples/default/reset.png" height="200" /> <img src="examples/default/receipt.png" height="200" />
+| Welcome | Reset Password | Receipt |
+|---------|----------------|---------|
+| <img src="examples/default/welcome.png" height="200" /> | <img src="examples/default/reset.png" height="200" /> | <img src="examples/default/receipt.png" height="200" /> |
 
 - `plain` by [Postmark Transactional Email Templates](https://github.com/ActiveCampaign/postmark-templates)
 
-<img src="examples/plain/welcome.png" height="200" /> <img src="examples/plain/reset.png" height="200" /> <img src="examples/plain/receipt.png" height="200" />
+| Welcome | Reset Password | Receipt |
+|---------|----------------|---------|
+| <img src="examples/plain/welcome.png" height="200" /> | <img src="examples/plain/reset.png" height="200" /> | <img src="examples/plain/receipt.png" height="200" /> |
+
+## RTL Support
+
+To change default text direction to RTL, you can use the `TextDirection` method:
+
+```go
+// Set the text direction when creating a new email
+email := mailgen.New().
+	TextDirection("rtl").
+	Line("هذا هو عنوان البريد الإلكتروني الخاص بك")
+// or set it globally
+mailgen.SetDefault(mailgen.New().TextDirection("rtl"))
+// Then build the email as usual
+email := mailgen.New().
+	Line("هذا هو عنوان البريد الإلكتروني الخاص بك")
+```
 
 ## Elements
 
@@ -112,15 +134,12 @@ Go-Mailgen provides several methods to add content to your emails. Here are some
 To add an action button to your email, use the `Action` method:
 
 ```go
-mailgen.New().
+email := mailgen.New().
 	Line("To confirm your email address, please click the button below:").
 	Action("Confirm Email", "https://example.com/confirm")
-```
 
-To add multiple actions to your email, you can chain the `Action` method:
-
-```go
-mailgen.New().
+// To add multiple actions, you can chain the `Action` method:
+email := mailgen.New().
 	Line("To confirm your email address, please click the buttons below:").
 	Action("Confirm Email", "https://example.com/confirm").
 	Line("Or you can visit our website:").
@@ -132,7 +151,7 @@ mailgen.New().
 To add a table to your email, use the `Table` method:
 
 ```go
-mailgen.New().
+email := mailgen.New().
 	Line("Your order has been processed successfully.").
 	Table(mailgen.Table{
 		Data: [][]mailgen.Entry{
@@ -162,7 +181,7 @@ mailgen.New().
 You can chain the `Table` with other methods to add more content to your email:
 
 ```go
-mailgen.New().
+email := mailgen.New().
 	Line("Your order has been processed successfully.").
 	Table(mailgen.Table{
 		Data: [][]mailgen.Entry{

builder.go

@@ -121,6 +121,16 @@ func (b *Builder) clone() *Builder {
 // SetDefault sets the default Builder instance.
 //
 // It can be useful for set global defaults or configurations for the email messages.
+//
+// Example usage:
+//
+//	mailgen.SetDefault(mailgen.New().
+//		Product(mailgen.Product{
+//			Name: "Go-Mailgen",
+//			Link: "https://github.com/ahmadfaizk/go-mailgen",
+//			Logo: "https://upload.wikimedia.org/wikipedia/commons/0/05/Go_Logo_Blue.svg",
+//		}).
+//		Theme("default"))
 func SetDefault(b *Builder) {
 	if b == nil {
 		return
@@ -132,7 +142,7 @@ func SetDefault(b *Builder) {
 //
 // Example usage:
 //
-//	message := mailer.NewMessage().
+//	message := mailgen.New().
 //		Subject("Reset Password").
 //		To("recipient@example.com").
 //		Line("Click the button below to reset your password").
@@ -229,7 +239,8 @@ func (b *Builder) TextDirection(direction string) *Builder {
 //
 // Example usage:
 //
-//	message.FallbackFormat("If you're having trouble clicking the \"[ACTION]\" button, copy and paste the URL below into your web browser:")
+//	email := mailgen.New().
+//		FallbackFormat("If you're having trouble clicking the \"[ACTION]\" button, copy and paste the URL below into your web browser:")
 func (b *Builder) FallbackFormat(format string) *Builder {
 	if format == "" {
 		return b // No format provided, do nothing
@@ -285,9 +296,14 @@ func (b *Builder) Linef(format string, args ...interface{}) *Builder {
 	return b.Line(text)
 }
 
-// Action sets the action text and URL for the email message.
-// It creates a button in the email that links to the specified URL.
-// The action can also include an optional instruction and color for the button.
+// Action sets the action text and link for the email message.
+// It creates a button that the recipient can click to perform an action.
+//
+// Example usage:
+//
+//	email := mailgen.New().
+//		Line("Click the button below to get started").
+//		Action("Get Started", "https://example.com/get-started")
 func (b *Builder) Action(text, link string, cfg ...Action) *Builder {
 	action := &component.Action{
 		Text:  text,
@@ -331,8 +347,9 @@ func (b *Builder) Product(product Product) *Builder {
 //
 // Example usage:
 //
-//	message.Table(mailer.Table{
-//		Data: [][]mailer.Entry{
+//	email := mailgen.New().
+//		Table(mailgen.Table{
+//			Data: [][]mailgen.Entry{
 //			{
 //				{Key: "Name", Value: "John Doe"},
 //				{Key: "Email", Value: "john.doe@example.com"},
@@ -342,7 +359,7 @@ func (b *Builder) Product(product Product) *Builder {
 //				{Key: "Email", Value: "jane.smith@example.com"},
 //			},
 //		},
-//		Columns: mailer.Columns{
+//		Columns: mailgen.Columns{
 //			CustomWidth: map[string]string{
 //				"Name":  "50%",
 //				"Email": "50%",
@@ -363,7 +380,9 @@ func (b *Builder) Table(table Table) *Builder {
 }
 
 // Build generates the final Message object with the HTML and plaintext content.
+//
 // It processes all the components, actions, and other fields set in the Builder.
+//
 // Returns an error if there is an issue generating the HTML or plaintext content.
 func (b *Builder) Build() (Message, error) {
 	b.beforeBuild()

examples/default/receipt.png

@@ -1,4 +1,4 @@
-[Go-Mailgen] ( https://github.com/ahmadfaizk/go-mailgen )
+[Go-Mailgen] (https://github.com/ahmadfaizk/go-mailgen)
 
 ************
 Hi John Doe,
@@ -13,7 +13,7 @@ Mailgen | Programmatically create beautiful e-mails using Golang   |  $1.99
 
 You can check the status of your order and more in your dashboard:
 
-Go to Dashboard ( https://example.com/dashboard )
+Go to Dashboard (https://example.com/dashboard)
 
 We thank you for your purchase.
 

examples/default/receipt.txt

@@ -1,4 +1,4 @@
-[Go-Mailgen] ( https://github.com/ahmadfaizk/go-mailgen )
+[Go-Mailgen] (https://github.com/ahmadfaizk/go-mailgen)
 
 ************
 Hi John Doe,
@@ -8,7 +8,7 @@ You have received this email because a password reset request for your account w
 
 Click the button below to reset your password:
 
-Reset your password ( https://example.com/reset-password )
+Reset your password (https://example.com/reset-password)
 
 If you did not request a password reset, no further action is required on your part.
 

examples/default/reset.png

@@ -1,4 +1,4 @@
-[Go-Mailgen] ( https://github.com/ahmadfaizk/go-mailgen )
+[Go-Mailgen] (https://github.com/ahmadfaizk/go-mailgen)
 
 ************
 Hi John Doe,
@@ -8,7 +8,7 @@ Welcome to Go-Mailgen! We're very excited to have you on board.
 
 To get started with Mailgen, please click here:
 
-Get Started ( https://example.com/get-started )
+Get Started (https://example.com/get-started)
 
 We're glad to have you on board.
 

examples/default/reset.txt

@@ -1,4 +1,4 @@
-[Go-Mailgen] ( https://github.com/ahmadfaizk/go-mailgen )
+[Go-Mailgen] (https://github.com/ahmadfaizk/go-mailgen)
 
 ************
 Hi John Doe,
@@ -13,7 +13,7 @@ Mailgen | Programmatically create beautiful e-mails using Golang   |  $1.99
 
 You can check the status of your order and more in your dashboard:
 
-Go to Dashboard ( https://example.com/dashboard )
+Go to Dashboard (https://example.com/dashboard)
 
 We thank you for your purchase.