Skip to content
Encode an image as a small string that can be saved in the database, returned in API responses, and displayed as a blurred preview before the real image loads
Branch: master
Clone or download
Latest commit 1e818ef May 4, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin Initial commit Apr 20, 2019
ext/blurhash Fix compile flags May 4, 2019
lib Bump version to 0.1.3 May 4, 2019
spec Add method to decode components Apr 26, 2019
.gitignore
.rspec Initial commit Apr 20, 2019
.travis.yml Fix compile flags May 4, 2019
CODE_OF_CONDUCT.md
Gemfile Initial commit Apr 20, 2019
Gemfile.lock Bump version to 0.1.3 May 4, 2019
LICENSE.txt Initial commit Apr 20, 2019
README.md Initial commit Apr 20, 2019
Rakefile Fix wrong path to compiled .so file Apr 25, 2019
blurhash.gemspec Add method to decode components Apr 26, 2019

README.md

Blurhash

This is a Ruby binding for the Blurhash library. With it you can encode an image as a small string that can be saved in the database, returned in API responses, and displayed as a blurred preview before the real image loads.

Blurhash is written by Dag Ågren.

Installation

Add this line to your application's Gemfile:

gem 'blurhash'

And then execute:

$ bundle

Or install it yourself as:

$ gem install blurhash

Usage

You need to read in the image pixel data yourself, for example with RMagick:

require 'blurhash'
require 'rmagick'

image = Magick::ImageList.new('foo.png')

puts Blurhash.encode(image.columns, image.rows, image.export_pixels)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Gargron/blurhash. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Blurhash project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

You can’t perform that action at this time.