File: README.md

package info (click to toggle)
ruby-png-quantizator 0.2.1-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 240 kB
  • sloc: ruby: 98; makefile: 4
file content (41 lines) | stat: -rw-r--r-- 957 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# PngQuantizator
[![Build Status](https://secure.travis-ci.org/rogercampos/png_quantizator.png)](http://travis-ci.org/rogercampos/png_quantizator)


PngQuantizator is a little wrapper around [ pngquant ](http://pngquant.org/).
Gives you a nice API to interact with the binary and meaningful exceptions in
the ruby world if `pngquant` throws an error.

## Installation

Add this line to your application's Gemfile:

    gem 'png_quantizator'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install png_quantizator

## Usage

```
file = PngQuantizator::Image.new("/path/to/image.png")

# Quantize to a new file
file.quantize_to("/path/to/destination.png")

# Quantize in place
file.quantize!
```

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request