folder-hash - npm Package Compare versions

Comparing version 3.2.0 to 3.3.0

index.js

@@ -299,2 +299,3 @@ const crypto = require('crypto'),
 module.exports = {
+    defaults: defaultOptions,
     hashElement: prep(require("graceful-fs"), Promise),
@@ -301,0 +302,0 @@ // exposed for testing

package.json

 {
   "name": "folder-hash",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "Create a hash checksum over a folder and its content - its children and their content",
   "main": "index.js",
+  "bin": {
+    "folder-hash": "bin/folder-hash"
+  },
   "scripts": {
@@ -7,0 +10,0 @@ "start": "node sample.js",

README.md

@@ -310,3 +310,26 @@ Create a hash checksum over a folder or a file.
 
+## Command line usage
+After installing it globally via
+```
+$ npm install -g folder-hash
+```
+You can use it like this:
+```
+# local folder
+$ folder-hash -c config.json .
+# local folder
+$ folder-hash
+# global folder
+$ folder-hash /user/bin
+```
 
+It also allows to pass an optional JSON configuration file with the `-c` or `--config` flag, which should contain the same configuration as when using the JavaScript API.
+
+You can also use a local version of folder-hash like this:
+```
+$ npx folder-hash --help
+Use folder-hash on cli like this:
+  folder-hash [--config <json-file>] <file-or-folder>
+```
+
 ## Examples
@@ -313,0 +336,0 @@ ### Other examples using promises

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

Lines of code

1054

increased by6.46%

Number of lines in readme file

444

increased by5.46%

Worsened metrics

Total package byte prevSize

56790

decreased by-32.24%

Number of package files

30

decreased by-3.23%

No dependency changes