Skip to content

Latest commit

 

History

History
47 lines (27 loc) · 1.44 KB

README.md

File metadata and controls

47 lines (27 loc) · 1.44 KB
Raw

libdeflate-ruby

Ruby bindings for libdeflate.

Installation

Add this line to your application's Gemfile:

gem 'libdeflate'

And then execute:

$ bundle

Or install it yourself as:

$ gem install libdeflate

Usage

require 'libdeflate'

compressor = Libdeflate::Compressor.new
compressed_string = compressor.compress('Hello, World!')

decompressor = Libdeflate::Decompressor.new
decompressor.decompress(compressed_string)

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/kaorimatz/libdeflate.

License

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

The gem bundles libdeflate, which is licensed under the terms of the MIT License.