Commits

Damon Oehlman  committed 50c033a

Added README

  • Participants
  • Parent commits 5cb16f6

Comments (0)

Files changed (1)

+# node-manifest
+
+1. This has nothing to do with HTML5 cache-manifest / appcache
+2. This is designed to make downloading multiple files from a remote web location (using [getit](https://github.com/DamonOehlman/getit)) via a simple manifest file, really bloody simple.
+
+## Installation
+
+```
+npm install node-manifest
+```
+
+## Example Usage
+
+```js
+var manifest = require('manifest');
+
+// download files from test.com 
+// as specified in the manifest file "http://test.com/manifest"
+// to the current working directory
+manifest.download('http://test.com/', function(err) {
+    // it's done
+});
+```
+
+More documentation to come, in the meantime have a look at the test directory.