Add a basic README

This commit is contained in:
Ivan Smirnov 2022-01-03 01:40:25 +03:00
parent 74fa9aaef2
commit bfd947f573

21
README.md Normal file
View file

@ -0,0 +1,21 @@
# qoi-fast
VERY fast encoder/decoder for [QOI image format](https://qoiformat.org/), implemented in pure Rust.
[![Build](https://github.com/aldanor/qoi-fast/workflows/CI/badge.svg)](https://github.com/aldanor/qoi-fast/actions?query=branch%3Amaster)
[![Latest Version](https://img.shields.io/crates/v/qoi-fast.svg)](https://crates.io/crates/qoi-fast)
[![Documentation](https://img.shields.io/docsrs/qoi-fast)](https://docs.rs/qoi-fast)
[![Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
Quick summary:
- One of the fastest encoders/decoders out there.
- Compliant with the latest QOI format specification.
- Supports decoding from streams and encoding to streams.
- No unsafe code.
### License
Dual-licensed under the terms of both the MIT license and the
Apache License (Version 2.0)