improve readme

2016-01-20 03:50:37 +01:00 · 2016-01-20 03:50:37 +01:00 · f5f12c6fa1
commit f5f12c6fa1
parent eb2b068870
1 changed files with 12 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,12 @@
+# remotezip
+downloads and extracts remote zip files
+
+```javascript
+var remotezip = require("remotezip");
+remotezip.get({
+    from:"https://example.com/example.zip",
+    toPath:"/some/local/absolute/path"
+});
+```
+
+For non zips there is remotefile.