docker-stream-cleanser - npm Package Compare versions

Comparing version 0.0.12 to 0.0.13

package.json

 {
   "name": "docker-stream-cleanser",
-  "version": "0.0.12",
+  "version": "0.0.13",
   "main": "app.js",
@@ -5,0 +5,0 @@ "devDependencies": {

README.md

@@ -16,2 +16,26 @@ Docker Stream Cleanser
 
+Usage
+----
+For clearing from stored logs:
+
+```sh
+var streamCleanser = require('docker-stream-cleanser');
+
+function(theData) {
+    var cleansed = streamCleanser(theData, 'hex');
+}
+```
+
+For clearing between streams:
+
+```sh
+var streamCleanser = require('docker-stream-cleanser');
+function(theStream) {
+    var cleansed = streamCleanser.cleanStreams(theStream, process.stdout, 'hex', true);
+}
+
+```
+
+For more info, look at the header comments and the tests
+
 Version
@@ -18,0 +42,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

77346

increased by0.6%

Number of lines in readme file

57

increased by72.73%

No dependency changes