colorpress

colorpress

Usage

Encode bytes of a file to PNG format:

Colorpress::encode('file.txt') # creates file.txt.png, minimum width 50 px
Colorpress::encode('file.txt', 'out.png', min_width=100) # creates out.png, minimum width 100 px

Decode bytes of a PNG back into character data:

Colorpress::decode('file.txt.png') # creates file.txt, deletes file.txt.png
Colorpress::decode('file.txt.png', cleanup=false) # creates file.txt, keeps file.txt.png
Colorpress::decode('out.png', 'original.txt') # creates original.txt, deletes out.png

Documentation for all methods can be generated by running yard doc in a development environment.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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/lucis-fluxum/colorpress. 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

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