changed-log - npm Package Compare versions

Comparing version 0.6.0 to 0.6.1

package.json

 {
   "name": "changed-log",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "Returns all commit messages between 2 versions of an NPM module",
@@ -5,0 +5,0 @@ "main": "src/changed-log.js",

README.md

@@ -40,2 +40,26 @@ # changed-log
 
+For private repos, you can authenticate one time (including 2Factor) by passing commandline
+option `--auth` with the command
+
+## Using as a module
+
+You can use `changed-log` as a module from your application.
+
+```js
+var changedLog = require('changed-log');
+// exports single function
+changedLog(options, reportingOptions);
+/*
+  options = {
+    auth: true | false - ask user to authenticate, optional 
+    name: <string> - package name OR <github username/repo name> to go directly to Github
+    from: <string> - first tag
+    to: <string> - second tag
+  },
+  reportingOptions = {
+    details: true | false - prints the full commit message if true, otherwise just first line
+  }
+*/
+```
+
 ### Small print
@@ -42,0 +66,0 @@

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

Improved metrics

Total package byte prevSize

424511

increased by0.16%

Number of lines in readme file

108

increased by28.57%

No dependency changes