https://github.com/cjpatoilo/imgcompile

Optimize and compress JPG, JPEG, PNG, GIF or SVG.
https://github.com/cjpatoilo/imgcompile

compile compress img jpeg jpg optimize png svg

Last synced: 7 months ago
JSON representation

Optimize and compress JPG, JPEG, PNG, GIF or SVG.

• Host: GitHub
• URL: https://github.com/cjpatoilo/imgcompile
• Owner: cjpatoilo
• License: mit
• Created: 2017-01-21T03:14:12.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2023-02-27T01:19:55.000Z (over 2 years ago)
• Last Synced: 2024-11-27T19:50:16.181Z (8 months ago)
• Topics: compile, compress, img, jpeg, jpg, optimize, png, svg
• Language: JavaScript
• Homepage: https://npmjs.com/imgcompile
• Size: 108 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Contributing: .github/contributing.md
  • Funding: .github/funding.yml
  • License: license

Awesome Lists containing this project

README

        
# IMGCompile

> Optimize and compress JPG, JPEG, PNG, GIF or SVG.

[![Travis Status](https://travis-ci.org/cjpatoilo/imgcompile.svg?branch=master)](https://travis-ci.org/cjpatoilo/imgcompile?branch=master)

[![AppVeyor Status](https://ci.appveyor.com/api/projects/status/qrud74xf6m4acmk4?svg=true)](https://ci.appveyor.com/project/cjpatoilo/imgcompile)

[![Codacy Status](https://img.shields.io/codacy/grade/34f3fc9fcfc04ace9385be43d8e5b79e/master.svg)](https://www.codacy.com/app/cjpatoilo/imgcompile/dashboard)

[![Dependencies Status](https://david-dm.org/cjpatoilo/imgcompile.svg)](https://david-dm.org/cjpatoilo/imgcompile)

[![Version Status](https://badge.fury.io/js/imgcompile.svg)](https://www.npmjs.com/package/imgcompile)

[![Download Status](https://img.shields.io/npm/dt/imgcompile.svg)](https://www.npmjs.com/package/imgcompile)

[![Gitter Chat](https://img.shields.io/badge/gitter-join_the_chat-4cc61e.svg)](https://gitter.im/cjpatoilo/imgcompile)

## Why it's awesome

No spend several hours setting configuration files. **IMGCompile** will compile, optimize and compress JPG, JPEG, PNG, GIF or SVG. Set folder name where the source code is located and we'll take care of the rest for you. Just it!

_NOTE: For now only works with JPG, JPEG, PNG, GIF and SVG._

## Getting Started

**Install with npm**

```

$ npm install imgcompile

```

**Install with Yarn**

```

$ yarn add imgcompile

```

**Run with npx (without installing)**

```

$ npx install imgcompile

```

**Usage**

```

$ imgcompile src dist

```

_NOTE: Only the folder name is required._

## CLI

```

$ imgcompile --help

  Usage:

    $ imgcompile  [] []

  Options:

    -h, --help              Display help information

    -v, --version           Output version

  Examples:

    $ imgcompile src

    $ imgcompile src dist

```

## Contributing

Want to contribute? Follow these [recommendations](https://github.com/cjpatoilo/imgcompile/contribute).

## License

Designed with ♥ by [CJ Patoilo](https://twitter.com/cjpatoilo). Licensed under the [MIT License](https://cjpatoilo.com/license).