Skip to content
A simple way to gzip your files http://caio-ribeiro-pereira.github.io/gzipme/
JavaScript
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
bin
lib
test
.gitignore
.npmignore
.travis.yml
CHANGELOG.md
Makefile
README.md
coverage.html
index.js
package.json

README.md

Build Status

Build StatusDependency Status

About

A simple Node module and CLI which gzip file for you! :)

It's very simple to use it, just follow the documentation below...

Module Version

Instalation

npm install gzipme

The code

var gzipme = require('gzipme');

gzipme("file.txt"); // it will compress and generate "file.txt.gz" in the same path.

gzipme("file.txt", true); // it will overwrite the "file.txt" replacing to the compressed file.

CLI Version

Instalation

npm install -g gzipme

The Command

gzipme file.txt

to compress and generate "file.txt.gz" in the same path.

or

gzipme -o file.txt

to overwrite the "file.txt" replacing to the compressed file.

Running tests

Just clone this repository, and follow the commands below:

git clone git@github.com:caio-ribeiro-pereira/gzipme.git
cd gzipme
npm install
npm test

It will run Mocha tests and will generate coverage reports.

Author

Caio Ribeiro Pereira caio.ribeiro.pereira@gmail.com

Twitter: http://twitter.com/crp_underground

Blog: http://udgwebdev.com

TODO

  • Decompress gzip files
  • Compress directories and subdirectories
  • Compress and Decompress in async function

New ideas will be welcome here! :D

License

The MIT License (MIT)

Copyright (c) 2013 caio.ribeiro.pereira@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.