https://github.com/woodruffw/lzfse.rb

Ruby bindings for Apple's LZFSE, including LZVN
https://github.com/woodruffw/lzfse.rb

apple compression lzfse

Last synced: 29 days ago
JSON representation

Ruby bindings for Apple's LZFSE, including LZVN

• Host: GitHub
• URL: https://github.com/woodruffw/lzfse.rb
• Owner: woodruffw
• License: mit
• Created: 2021-05-31T18:28:42.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-02T13:08:38.000Z (2 months ago)
• Last Synced: 2024-10-06T03:39:35.553Z (about 1 month ago)
• Topics: apple, compression, lzfse
• Language: C
• Homepage: https://rubygems.org/gems/lzfse
• Size: 97.7 KB
• Stars: 7
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
lzfse.rb

========

[![CI](https://github.com/woodruffw/lzfse.rb/actions/workflows/ci.yml/badge.svg)](https://github.com/woodruffw/lzfse.rb/actions/workflows/ci.yml)

[![Gem Version](https://badge.fury.io/rb/lzfse.svg)](https://badge.fury.io/rb/lzfse)

Ruby bindings for Apple's reference implementation of [LZFSE](https://github.com/lzfse/lzfse).

Bindings are also provided for the internal LZVN APIs.

## Usage

You'll need the gem:

```bash

gem install lzfse

```

Then, use the four public APIs:

```ruby

require "lzfse"

# LZFSE

compressed = LZFSE.lzfse_compress "please compress this string"

LZFSE.lzfse_decompress compressed

# LZVN

compressed = LZFSE.lzvn_compress "please also compress this string!"

LZFSE.lzvn_compress compressed

```

Each API takes a single string and returns a string.

## License

*lzfse.rb* is licensed under the MIT license.

Apple's reference implementation of LZFSE is licensed under the 3-clause BSD license.