From f5f12c6fa101952b8608b7e2633d0ac79ec4cc57 Mon Sep 17 00:00:00 2001 From: PhilKunz Date: Wed, 20 Jan 2016 03:50:37 +0100 Subject: [PATCH] improve readme --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1783fef --- /dev/null +++ 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. \ No newline at end of file