registry-sync - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

package.json

 {
   "name": "registry-sync",
-  "version": "1.0.1",
+  "version": "1.0.2",
+  "description": "synchronize a remote npm registry for private use",
   "repository": "https://github.com/heikkipora/registry-sync",
@@ -26,3 +27,6 @@ "bin": {
     "offline"
-  ]
+  ],
+  "engines": {
+    "node": ">=4.4.0"
+  }
 }

README.md

@@ -8,2 +8,6 @@ # registry-sync
 
+## Pre-requisites
+
+- Node.js v4.4.0 or newer
+
 ## Installation
@@ -15,5 +19,5 @@
 
-Usage: bin/sync [options]
+### Synchronizing packages from the npmjs.org registry:
 
-  Options:
+    registry-sync [options]
 
@@ -27,7 +31,13 @@ -h, --help           output usage information
 
+Example:
 
-Usage: bin/serve [options]
+    registry-sync --root /tmp/my-registry --manifest ./package.json --localUrl http://localhost:8000
 
-  Options:
+..where the referred ```package.json``` file needs to contain at least a "dependencies" section.
+Re-executing ```registry-sync``` will only download and update files for new package versions.
 
+### Serving the local registry after synchronization:
+
+    registry-serve [options]
+
     -h, --help       output usage information
@@ -38,4 +48,8 @@ -V, --version    output the version number
 
+Example:
+
+    registry-serve --root /tmp/my-registry --port 8000
+
 ## Using a proper web server instead of bin/serve (recommended)
 
 Configure your web server to use `index.json` as index file name instead of `index.html`.

No alert changes

Improved metrics

Total package byte prevSize

11070

increased by5.93%

Number of lines in readme file

52

increased by36.84%

No dependency changes