From 4bc1c0da13513ed84be07db54a60c26e9ccc6c51 Mon Sep 17 00:00:00 2001
From: Jaroslav Vrana <jaroslav.vrana@integromat.com>
Date: Thu, 10 Jun 2021 21:48:33 +0200
Subject: [PATCH] docs: README update & formatting

Picked from #158c48fc75d0f86e643095320ae7b899485b54001 by justin713
---
 README.md | 83 +++++++++++++++++++++++++++----------------------------
 1 file changed, 41 insertions(+), 42 deletions(-)

diff --git a/README.md b/README.md
index 42a7923..4722413 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,10 @@
-## gulp-mail
+# gulp-mail
 
-<a href="https://www.npmjs.com/package/gulp-mail"><img width="134" height="20" src="https://img.shields.io/npm/dm/gulp-mail.svg"></a>&nbsp;&nbsp;<a href="https://github.com/fritx/gulp-mail"><img width="78" height="20" src="http://img.shields.io/badge/license-MIT-blue.svg"></a>
-
-A [gulp](https://github.com/gulpjs/gulp) wrapper for [Nodemailer](https://nodemailer.com) used to quickly send emails from tasks and/or the command-line during development or testing.
+> A [gulp](https://github.com/gulpjs/gulp) wrapper for [Nodemailer](https://nodemailer.com) used to quickly send emails from tasks and/or the command-line during development or testing.
 
 `gulp-mail` is based on [gulp-mailer](https://github.com/meerkats/gulp-mailer), which is not available on [npm](https://www.npmjs.com/).
 
-### Installation
+## Installation
 
 Installing via [npm](https://www.npmjs.org/package/gulp-mail):
 
@@ -14,40 +12,41 @@ Installing via [npm](https://www.npmjs.org/package/gulp-mail):
 npm install --save-dev gulp-mail
 ```
 
-### Usage
+## Usage
+
+### `mail(options)`
 
-#### `mail(options)`
-- options: `Object`
+*   options: `Object`
 
-### Options
+## Options
 
-`gulp-mail` uses Nodemailer v0.7.1, which has been deprecated for some time. It is, however, simple and stable. Available options for `gulp-mail` are:
+`gulp-mail` uses **Nodemailer v0.7.1**, which has been deprecated for some time.  It is, however, simple and stable. Available options for `gulp-mail` are:
 
-##### options.smtp
-Type: `Object`  
-Contains required SMTP configuration values. (See the example below.)
+*   ### `options.smtp`
+    Type: `Object`\
+    Contains required SMTP configuration values. (See the example below.)
 
-##### options.to
-Type: `String|Array`  
-A string or array containing one or more than one recipient address, respectively.
+*   ### `options.to`
+    Type: `String|Array`\
+    A string or array containing one or more than one recipient address, respectively.
 
-##### options.from
-Type: `String`  
-The display name for the sender.
+*   ### `options.from`
+    Type: `String`\
+    The display name for the sender.
 
-##### options.subject
-Type: `String`  
-The email subject line. If not provided, a default subject line is generated from the source filename as `[TEST] path.basename`.
+*   ### `options.subject`
+    Type: `String`\
+    The email subject line. If not provided, a default subject line is generated from the source filename as `[TEST] path.basename`.
 
-##### options.html
-Type: `String`  
-The HTML body of the email. If not provided, the source file becomes the message body.
+*   ### `options.html`
+    Type: `String`\
+    The HTML body of the email. If not provided, the source file becomes the message body.
 
-##### options.text
-Type: `String`  
-The plaintext body of the email. If not provided, Nodemailer generates this based on the source file.
+*   ### `options.text`
+    Type: `String`\
+    The plaintext body of the email. If not provided, Nodemailer generates this based on the source file.
 
-### Example
+## Example
 
 Currently, `gulp-mail` takes in piped streams and sends emails via SMTP only.
 
@@ -55,25 +54,25 @@ Currently, `gulp-mail` takes in piped streams and sends emails via SMTP only.
 var gulp = require('gulp');
 var mail = require('gulp-mail');
 
-var smtpInfo = {
-  auth: {
-    user: 'foo@163.com',
-    pass: '123456'
-  },
-  host: 'smtp.163.com',
-  secureConnection: true,
-  port: 465
+var smtpConfig = {
+    host: 'smtp.example.com',
+    port: 465,
+    secureConnection: true,
+    auth: {
+      user: 'user@example.com',
+      pass: 'correcthorsebatterystaple'
+    }
 };
 
 gulp.task('mail', function () {
-  return gulp.src('./mails/i-love-you.html')
+  return gulp.src('path/to/message.html')
     .pipe(mail({
-      subject: 'Surprise!?',
       to: [
-        'bar@gmail.com'
+        'bar@example.com'
       ],
-      from: 'Foo <foo@163.com>',
-      smtp: smtpInfo
+      from: 'Example <user@example.com>',
+      subject: 'A message from gulp-mail',
+      smtp: smtpConfig
     }));
 });
 ```