# swill

`swill` is a work-in-progress sixel library. I was dissatisfied with the
existing [libsixel](https://github.com/saitoha/libsixel), which seems primarily
designed not as a general-purpose library, but rather to implement its demo
applications. For example, the `sixel_encoder` object provided in the public API
actually handles `img2sixel`'s option processing, and is only capable of
outputting to a file or stdout. The lower-level `sixel_encode` provided in the
public API is also heavily focused on outputting to files. There wasn't any way
provided to get the sixel as a buffer -- or at least not any *documented* means.

`swill` therefore has the following priorities:
- Provide essential sixel conversion capabilities, and leave handling the data
to the developer.
- Publically provide general-purpose methods, rather than providing
"batteries-included" interfaces that might be unsuitable for some uses.
- Be thoroughly and clearly documented.