transform-files - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "transform-files",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Transform all files in one directory (and below) to another (or the same). Use underscore templates.",
@@ -5,0 +5,0 @@ "main": "app.js",

README.md

@@ -1,2 +0,33 @@
-# node-transform-files
+# NodeJS Transform
 Transform all files in one directory (and below) to another (or the same). Use underscore templates.
+
+# Install
+
+`npm install transform-files`
+
+or if you want it system wide: (-g = global)
+
+`npm install -g transform-files`
+
+# Usage
+
+You can use this NPM as a program or as dependency in your own NPM.
+
+## From command line
+
+```
+Usage: transform dir/ newdir/ [data]
+       transform /etc /docker/etc '{"domain": "example.com"}'
+```
+
+## In a module
+
+```javascript
+var transform = require('transform-files');
+var inputDir = 'config/';
+var outputDir = 'newConfig/';
+
+var data = someAPI.fetch(); // Return a javascript object. For ex. { domain: 'example.com' }
+
+transform(inputDir, outputDir, data);
+```

No alert changes

Improved metrics

Total package byte prevSize

6291

increased by10.43%

Number of lines in readme file

34

increased by1033.33%

No dependency changes