diff --git a/README.md b/README.md new file mode 100644 index 0000000..60d29b4 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +node-compress +============= + +A streaming compression / gzip module for node.js + +To install, ensure that you have libz installed, and run: + +node-waf configure +node-waf build + +This will put the compress.node binary module in build/default. + + +Quick example +------------- + +var compress=require("./compress"); +var sys=require("sys"); +var posix=require("posix"); + +// Create gzip stream +var gzip=new compress.Gzip; +gzip.init(); + +// Pump data to be compressed +var gzdata1 = gzip.deflate("My data that needs ", "binary"); +sys.puts("Compressed size : "+gzdata1.length); + +var gzdata2 = gzip.deflate("to be compressed. 01234567890.", "binary"); +sys.puts("Compressed size : "+gzdata2.length); + +var gzdata3 = gzip.end(); +sys.puts("Last bit : "+gzdata3.length); + +// Normally stream this out as its generated, but just print here +var gzdata = gzdata1+gzdata2+gzdata3; +sys.puts("Total compressed size : "+gzdata.length); \ No newline at end of file