diff --git a/README.md b/README.md index 2fadd40..b3ffcac 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,11 @@ > [!IMPORTANT] > dot-mail is a wrapper on top of [laminas-mail](https://github.com/laminas/laminas-mail) -> -> ![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.github.com%2Frepos%2Flaminas%2Flaminas-mail%2Fproperties%2Fvalues&query=%24%5B%3F(%40.property_name%3D%3D%22maintenance-mode%22)%5D.value&label=Maintenance%20Mode&color=%23d43442) ## dot-mail badges ![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-mail) -![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-mail/4.1.1) +![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-mail/4.3.0) [![GitHub issues](https://img.shields.io/github/issues/dotkernel/dot-mail)](https://github.com/dotkernel/dot-mail/issues) [![GitHub forks](https://img.shields.io/github/forks/dotkernel/dot-mail)](https://github.com/dotkernel/dot-mail/network) @@ -18,7 +16,13 @@ [![Build Static](https://github.com/dotkernel/dot-mail/actions/workflows/continuous-integration.yml/badge.svg?branch=4.0)](https://github.com/dotkernel/dot-mail/actions/workflows/continuous-integration.yml) [![codecov](https://codecov.io/gh/dotkernel/dot-mail/branch/4.0/graph/badge.svg?token=G51NEHYKD3)](https://codecov.io/gh/dotkernel/dot-mail) -[![SymfonyInsight](https://insight.symfony.com/projects/1995ea7c-3b34-4eee-ac48-3571860d0307/big.svg)](https://insight.symfony.com/projects/1995ea7c-3b34-4eee-ac48-3571860d0307) +## Installation + +Install `dotkernel/dot-mail` by executing the following Composer command: + +```shell +composer require dotkernel/dot-mail +``` ## Configuration diff --git a/SECURITY.md b/SECURITY.md index d2f1064..cac779d 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -5,7 +5,7 @@ | Version | Supported | PHP Version | |---------|--------------------|----------------------------------------------------------------------------------------------------------| -| 4.x | :white_check_mark: | ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-mail/4.1.1) | +| 4.x | :white_check_mark: | ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-mail/4.3.0) | | <= 3.x | :x: | | diff --git a/composer.json b/composer.json index aa5f497..da865c9 100644 --- a/composer.json +++ b/composer.json @@ -1,7 +1,7 @@ { "name": "dotkernel/dot-mail", "type": "library", - "description": "DotKernel mail component based on laminas-mail", + "description": "Dotkernel mail component based on laminas-mail", "license": "MIT", "homepage": "https://github.com/dotkernel/dot-mail", "keywords": [ @@ -15,7 +15,7 @@ ], "authors": [ { - "name": "DotKernel Team", + "name": "Dotkernel Team", "email": "team@dotkernel.com" } ], @@ -34,7 +34,7 @@ "dotkernel/dot-event": "^3.4" }, "require-dev": { - "laminas/laminas-coding-standard": "^2.5", + "laminas/laminas-coding-standard": "^3.0", "mikey179/vfsstream": "^v1.6.11", "phpunit/phpunit": "^10.5", "vimeo/psalm": "^5.23" diff --git a/config/mail.global.php.dist b/config/mail.global.php.dist index 41ae410..bbec2cc 100644 --- a/config/mail.global.php.dist +++ b/config/mail.global.php.dist @@ -3,7 +3,7 @@ return [ /** - * DotKernel mail module configuration + * Dotkernel mail module configuration * Note that many of these options can be set programmatically too, when sending mail messages * actually that is what you'll usually do, these config provide just default and options that remain the same for all mails */ diff --git a/docs/book/index.md b/docs/book/index.md deleted file mode 100644 index ae42a26..0000000 --- a/docs/book/index.md +++ /dev/null @@ -1 +0,0 @@ -../../README.md diff --git a/docs/book/index.md b/docs/book/index.md new file mode 120000 index 0000000..fe84005 --- /dev/null +++ b/docs/book/index.md @@ -0,0 +1 @@ +../../README.md \ No newline at end of file diff --git a/docs/book/v4/installation.md b/docs/book/v4/installation.md index d0eff73..faf95d5 100644 --- a/docs/book/v4/installation.md +++ b/docs/book/v4/installation.md @@ -2,4 +2,6 @@ Install `dotkernel/dot-mail` by executing the following Composer command: - composer require dotkernel/dot-mail +```shell +composer require dotkernel/dot-mail +``` diff --git a/docs/book/v4/overview.md b/docs/book/v4/overview.md index 3be8047..0fc3a17 100644 --- a/docs/book/v4/overview.md +++ b/docs/book/v4/overview.md @@ -1,8 +1,6 @@ # Overview > dot-mail is a wrapper on top of [laminas-mail](https://github.com/laminas/laminas-mail) -> -> ![OSS Lifecycle](https://img.shields.io/osslifecycle/laminas/laminas-mail) ## Extra features diff --git a/mkdocs.yml b/mkdocs.yml index 8889230..f9c775f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -14,7 +14,7 @@ nav: - Usage: v4/usage.md - Transports: v4/transports.md site_name: dot-mail -site_description: "DotKernel's mail service" +site_description: "Dotkernel's mail service" repo_url: "https://github.com/dotkernel/dot-mail" plugins: - search