Add documentation and examples

README.md

@@ -1,4 +1,115 @@
+
+
 MonologPHPMailer
 ================
 
-[PHPMailer](https://github.com/PHPMailer/PHPMailer/) handler for [Monolog](https://github.com/Seldaek/monolog/).
+[![Latest Stable Version][icon-stable-version]][link-packagist]
+[![Latest Untable Version][icon-unstable-version]][link-packagist]
+[![Total Downloads][icon-downloads]][link-packagist]
+[![License][icon-license]][link-license]
+[![PHP][icon-php]][link-php]
+
+[![Linux Build Status][icon-travis]][link-travis]
+[![Windows Build Status][icon-appveyor]][link-appveyor]
+[![Code Coverage][icon-coverage]][link-coverage]
+[![Code Quality][icon-quality]][link-quality]
+
+MonologPHPMailer is a [PHPMailer][link-phpmailer] handler for [Monolog][link-monolog]. It enables you to send logs to emails with PHPMailer.
+
+## Installation
+
+### Requirements
+
+MonologPHPMailer requires *[PHP][link-php] 5.5.0* or higher, *[Monolog][link-monolog] 1.x* and *[PHPMailer][link-phpmailer] 6.x*. Monolog 2.x **is not** supported, but it will be supported in the future.
+
+### Using Composer
+
+The reccomended way to install MonologPHPMailer is with [Composer][link-composer], dependency manager for PHP.
+
+You should just add `filips123/monolog-phpmailer` to your project dependencies in `composer.json`. It will also install Monolog and PHPMailer, but it is reccomended to add them manually to `composer.json`.
+
+```json
+{
+    "require": [
+        "monolog/monolog": "^1.0",
+        "phpmailer/phpmailer": "^6.0",
+        "filips123/monolog-phpmailer": "^1.0"
+    ]
+}
+```
+
+Do not forget to run `composer install` and add `require 'vendor/autoload.php';` to your main script.
+
+### Manually Installation
+
+Alternatively, you could download [`PHPMailerHandler.php`][link-handler] from GitHub and then manually include it in your script. You also have to install Monolog and PHPMailer manually.
+
+## Usage
+
+You should just add handler `MonologPHPMailer\PHPMailerHandler` to your logger. It's first argument must be PHPMailer instance.
+
+## Example
+
+```php
+<?php
+
+use MonologPHPMailer\PHPMailerHandler;
+
+use Monolog\Formatter\HtmlFormatter;
+use Monolog\Logger;
+use Monolog\Processor\IntrospectionProcessor;
+use Monolog\Processor\MemoryUsageProcessor;
+use Monolog\Processor\WebProcessor;
+
+use PHPMailer\PHPMailer\PHPMailer;
+
+require __DIR__ . '/vendor/autoload.php';
+
+$mailer = new PHPMailer(true);
+$logger = new Logger('logger');
+
+$mailer->isSMTP();
+$mailer->Host = 'smtp.example.com';
+$mailer->SMTPAuth = true;
+$mailer->Username = 'server@example.com';
+$mailer->Password = 'password';
+
+$mailer->setFrom('server@example.com', 'Logging Server');
+$mailer->addAddress('user@example.com', 'Your Name');
+
+$logger->pushProcessor(new IntrospectionProcessor);
+$logger->pushProcessor(new MemoryUsageProcessor);
+$logger->pushProcessor(new WebProcessor);
+
+$handler = new PHPMailerHandler($mailer);
+$handler->setFormatter(new HtmlFormatter);
+
+$logger->pushHandler($handler);
+
+$logger->error('Error!');
+$logger->alert('Something went wrong!');
+
+```
+
+[icon-stable-version]: https://img.shields.io/packagist/v/filips123/monolog-phpmailer.svg?style=flat-square&label=Latest+Stable+Version
+[icon-unstable-version]: https://img.shields.io/packagist/vpre/filips123/monolog-phpmailer.svg?style=flat-square&label=Latest+Unstable+Version
+[icon-downloads]: https://img.shields.io/packagist/dt/filips123/monolog-phpmailer.svg?style=flat-square&label=Downloads
+[icon-license]: https://img.shields.io/packagist/l/filips123/monolog-phpmailer.svg?style=flat-square&label=License
+[icon-php]: https://img.shields.io/packagist/php-v/filips123/monolog-phpmailer.svg?style=flat-square&label=PHP
+[icon-travis]: https://img.shields.io/travis/com/filips123/MonologPHPMailer.svg?style=flat-square&label=Linux+Build+Status
+[icon-appveyor]: https://img.shields.io/appveyor/ci/filips123/MonologPHPMailer.svg?style=flat-square&label=Windows+Build+Status
+[icon-coverage]: https://img.shields.io/scrutinizer/coverage/g/filips123/MonologPHPMailer.svg?style=flat-square&label=Code+Coverage
+[icon-quality]: https://img.shields.io/scrutinizer/g/filips123/MonologPHPMailer.svg?style=flat-square&label=Code+Quality
+
+[link-packagist]: https://packagist.org/packages/filips123/monolog-phpmailer/
+[link-license]: https://choosealicense.com/licenses/mit/
+[link-php]: https://php.net/
+[link-travis]: https://travis-ci.com/filips123/MonologPHPMailer/
+[link-appveyor]: https://ci.appveyor.com/project/filips123/monologphpmailer/
+[link-coverage]: https://scrutinizer-ci.com/g/filips123/MonologPHPMailer/code-structure/
+[link-quality]: https://scrutinizer-ci.com/g/filips123/MonologPHPMailer/
+
+[link-monolog]: https://github.com/Seldaek/monolog/
+[link-phpmailer]: https://github.com/PHPMailer/PHPMailer/
+[link-composer]: https://getcomposer.org/
+[link-handler]: https://github.com/filips123/MonologPHPMailer/blob/master/src/PHPMailerHandler.php

example.php

@@ -0,0 +1,37 @@
+<?php
+
+use MonologPHPMailer\PHPMailerHandler;
+
+use Monolog\Formatter\HtmlFormatter;
+use Monolog\Logger;
+use Monolog\Processor\IntrospectionProcessor;
+use Monolog\Processor\MemoryUsageProcessor;
+use Monolog\Processor\WebProcessor;
+
+use PHPMailer\PHPMailer\PHPMailer;
+
+require __DIR__ . '/vendor/autoload.php';
+
+$mailer = new PHPMailer(true);
+$logger = new Logger('logger');
+
+$mailer->isSMTP();
+$mailer->Host = 'smtp.example.com';
+$mailer->SMTPAuth = true;
+$mailer->Username = 'server@example.com';
+$mailer->Password = 'password';
+
+$mailer->setFrom('server@example.com', 'Logging Server');
+$mailer->addAddress('user@example.com', 'Your Name');
+
+$logger->pushProcessor(new IntrospectionProcessor);
+$logger->pushProcessor(new MemoryUsageProcessor);
+$logger->pushProcessor(new WebProcessor);
+
+$handler = new PHPMailerHandler($mailer);
+$handler->setFormatter(new HtmlFormatter);
+
+$logger->pushHandler($handler);
+
+$logger->error('Error!');
+$logger->alert('Something went wrong!');