docs(mailer): refresh docs for ci and test flow 📖

- Add changelog with release notes and recent updates
- Add ci badge and env based testing instructions in readme
- Expand usage guide with encoding and embedded disposition examples

Author: NeaByteLab

CHANGELOG.md

@@ -0,0 +1,51 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Added test suite under `tests/` covering:
+  SMTP address parsing, SMTP connection behavior, SMTP message formatting,
+  calendar formatting, and utility validation helpers
+- Added integration test coverage for real SMTP send flows:
+  plain text, HTML, attachments, embedded images, calendar invite,
+  mixed recipients, custom headers, and secure TLS transport
+- Added test environment setup examples in `README.md` using `.env` and shell exports
+
+### Changed
+
+- Sorted test case descriptions in ascending A-Z order for consistency
+- Improved several test descriptions to be clearer and more specific
+- Expanded `USAGE.md` with attachment encoding options (`base64`, `7bit`, `quoted-printable`)
+  and embedded image disposition options (`inline`, `attachment`)
+- Updated `README.md` features to mention transfer encoding support
+
+## [0.1.0] - 2025-10-22
+
+### Added
+
+- Initial public release of `@neabyte/deno-mailer`
+- SMTP email client with transporter API and message sender interface
+- Core email capabilities: plain text, HTML, mixed body, and custom headers
+- Flexible recipient handling for string, object, and mixed address formats
+- Attachment and embedded image support with MIME multipart formatting
+- Calendar invite support through generated iCalendar payloads
+- SMTP connection flow with STARTTLS and TLS transport options
+- SMTP authentication support with LOGIN and PLAIN mechanisms
+- Utility modules for SMTP config, attachment, content-id, and email validation
+- JSR publish workflow and package metadata setup
+
+### Changed
+
+- Refactored SMTP modules to align naming and documentation
+- Refactored utility modules to unify imports and content helper naming
+- Updated docs split between `README.md` and `USAGE.md`
+- Updated `@std/assert` dependency import version
+
+[Unreleased]: https://github.com/NeaByteLab/Deno-Mailer/compare/9618b63...HEAD
+[0.1.0]: https://github.com/NeaByteLab/Deno-Mailer/commit/9618b63

README.md

@@ -4,7 +4,7 @@
 
 Lightweight Deno SMTP mailer with flexible configuration and formatting.
 
-[![Deno](https://img.shields.io/badge/deno-%3E%3D2.x-000000?logo=deno&logoColor=white)](https://deno.com) [![JSR](https://jsr.io/badges/@neabyte/deno-mailer)](https://jsr.io/@neabyte/deno-mailer) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![Deno](https://img.shields.io/badge/deno-%3E%3D2.x-000000?logo=deno&logoColor=white)](https://deno.com) [![JSR](https://jsr.io/badges/@neabyte/deno-mailer)](https://jsr.io/@neabyte/deno-mailer) [![CI](https://github.com/NeaByteLab/Deno-Mailer/actions/workflows/ci.yml/badge.svg)](https://github.com/NeaByteLab/Deno-Mailer/actions/workflows/ci.yml) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
 
 </div>
 
@@ -14,6 +14,7 @@ Lightweight Deno SMTP mailer with flexible configuration and formatting.
 - **Flexible recipients**: supports string, object, and mixed recipient formats
 - **Rich message content**: plain text, HTML, mixed body, and custom headers
 - **Attachments and inline media**: supports file attachments and embedded images
+- **Transfer control options**: supports base64, 7bit, and quoted-printable encodings
 - **Calendar invitations**: generates ICS calendar payload for meeting invites
 - **Zero external runtime deps**: built with Deno native capabilities
 
@@ -58,9 +59,34 @@ await transporter.send({
 deno task check
 ```
 
+## Test
+
+```bash
+# Copy env template for SMTP integration tests.
+cp .env.example .env
+```
+
+```bash
+# Set ETHEREAL_USER and ETHEREAL_PASS in .env, then run test suite.
+deno task test
+```
+
+```bash
+# Alternative: export credentials in shell, then run test suite.
+export ETHEREAL_USER=your-ethereal-username
+export ETHEREAL_PASS=your-ethereal-password
+
+# Optional: run secure TLS (port 465) integration test too.
+export RUN_SECURE_SMTP_TEST=true
+
+# Run full unit and integration tests.
+deno task test
+```
+
 ## Reference
 
 - [USAGE.md](USAGE.md): complete API usage, configuration, and troubleshooting
+- [CHANGELOG.md](CHANGELOG.md): release history and notable changes
 
 ## Contributing
 

USAGE.md

@@ -17,7 +17,9 @@ This document explains the full **Deno Mailer** usage flow, from SMTP configurat
   - [Advanced Recipient Formats](#advanced-recipient-formats)
 - [Advanced Features](#advanced-features)
   - [File Attachments](#file-attachments)
+  - [Attachment Encoding Options](#attachment-encoding-options)
   - [Embedded Images](#embedded-images)
+  - [Embedded Image Disposition](#embedded-image-disposition)
   - [Calendar Invitations](#calendar-invitations)
   - [Custom Headers](#custom-headers)
 - [API Reference](#api-reference)
@@ -182,6 +184,38 @@ await transporter.send({
 })
 ```
 
+### Attachment Encoding Options
+
+```ts
+// Use base64, 7bit, or quoted-printable transfer encoding.
+await transporter.send({
+  from: 'sender@example.com',
+  to: 'recipient@example.com',
+  subject: 'Attachment Encoding Options',
+  text: 'Different transfer encodings are supported',
+  attachments: [
+    {
+      filename: 'base64.txt',
+      content: fileBase64Content,
+      contentType: 'text/plain',
+      encoding: 'base64'
+    },
+    {
+      filename: 'plain.txt',
+      content: 'Plain text body',
+      contentType: 'text/plain',
+      encoding: '7bit'
+    },
+    {
+      filename: 'qp.txt',
+      content: 'Quoted printable body',
+      contentType: 'text/plain',
+      encoding: 'quoted-printable'
+    }
+  ]
+})
+```
+
 ```ts
 // Send multiple attachments with mixed content types.
 await transporter.send({
@@ -233,6 +267,36 @@ await transporter.send({
 })
 ```
 
+### Embedded Image Disposition
+
+```ts
+// Set inline or attachment disposition for embedded images.
+await transporter.send({
+  from: 'sender@example.com',
+  to: 'recipient@example.com',
+  subject: 'Embedded Image Disposition',
+  html: '<h1>Hello!</h1><img src="cid:logo">',
+  embeddedImages: [
+    {
+      filename: 'logo.png',
+      content: imageContent,
+      contentType: 'image/png',
+      cid: '<logo@example.com>',
+      disposition: 'inline',
+      encoding: 'base64'
+    },
+    {
+      filename: 'badge.png',
+      content: badgeContent,
+      contentType: 'image/png',
+      cid: '<badge@example.com>',
+      disposition: 'attachment',
+      encoding: 'base64'
+    }
+  ]
+})
+```
+
 ### Calendar Invitations
 
 ```ts
@@ -329,6 +393,9 @@ await transporter.send({
 | `calendarEvent`  | object        | no       | Calendar invitation          |
 | `headers`        | object        | no       | Custom email headers         |
 
+Attachment and embedded image encoding supports `base64`, `7bit`, and `quoted-printable`.
+Embedded image disposition supports `inline` and `attachment`.
+
 ### Error Handling
 
 ```ts