winston-mail - npm Package Compare versions

Comparing version 0.5.0 to 1.0.0

changelog.md

 
+1.0.0 / 2015-11-06
+==================
+
+  * No breaking changes, just locking in a stable semver
+  * Testing for Node 4/5
+  * Support Winston >=0.5.0 <3.0.0
+  * Add timeout option for setting SMTP timeout
+
 0.5.0 / 2015-09-16
@@ -3,0 +11,0 @@ ==================

lib/winston-mail.js

@@ -50,3 +50,4 @@ /*
     ssl             : options.ssl || options.secure,
-    tls             : options.tls
+    tls             : options.tls,
+    timeout         : options.timeout,
   });
@@ -53,0 +54,0 @@ };

package.json

 {
   "name": "winston-mail",
   "description": "A mail transport for winston",
-  "version": "0.5.0",
+  "version": "1.0.0",
   "author": "Marc Harter <[e-mail]>",
@@ -30,3 +30,3 @@ "contributors": [
   "peerDependencies": {
-    "winston": ">=0.5.0 <2.0.0"
+    "winston": ">=0.5.0 <3.0.0"
   },
@@ -33,0 +33,0 @@ "main": "./lib/winston-mail",

readme.md

@@ -1,2 +0,2 @@
-# winston-mail [![Build Status](https://travis-ci.org/wavded/winston-mail.svg?branch=master)](https://travis-ci.org/wavded/winston-mail)
+![NPM](https://img.shields.io/npm/v/winston-mail.svg) [![Build Status](https://travis-ci.org/wavded/winston-mail.svg?branch=master)](https://travis-ci.org/wavded/winston-mail) ![Downloads](https://img.shields.io/npm/dt/winston-mail.svg)
 
@@ -7,26 +7,18 @@ A email transport for [winston][0].
 
-### Installing npm (node package manager)
-
 ``` sh
-  $ curl http://npmjs.org/install.sh | sh
+$ npm install winston
+$ npm install winston-mail
 ```
 
-### Installing winston-mail
-
-``` sh
-  $ npm install winston
-  $ npm install winston-mail
-```
-
 ## Usage
 ``` js
-  var winston = require('winston');
+var winston = require('winston');
 
-  //
-  // Requiring `winston-mail` will expose
-  // `winston.transports.Mail`
-  //
-  require('winston-mail').Mail;
+/*
+ * Requiring `winston-mail` will expose
+ * `winston.transports.Mail`
+ */
+require('winston-mail').Mail;
 
-  winston.add(winston.transports.Mail, options);
+winston.add(winston.transports.Mail, options);
 ```
@@ -49,2 +41,3 @@
 * __html:__ Boolean flag indicating whether to send mail body as html attach.
+* __timeout:__ Maximum number of milliseconds to wait for smtp responses (optional, defaults to emailjs defaults - 5000)
 
@@ -60,3 +53,3 @@ ## Subject templating
 
-Copyright (c) 2015 Marc Harter
+Copyright (C) 2015 Marc Harter
 
@@ -63,0 +56,0 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

10521

increased by3.21%

Lines of code

123

increased by0.82%

Number of low quality alerts

1

decreased by-50%

Worsened metrics

Number of lines in readme file

60

decreased by-10.45%

No dependency changes