From bfd947f573c2adf74d6bf0fdf06f737fc15fd20e Mon Sep 17 00:00:00 2001 From: Ivan Smirnov Date: Mon, 3 Jan 2022 01:40:25 +0300 Subject: [PATCH] Add a basic README --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..31a5763 --- /dev/null +++ b/README.md @@ -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)