# YAGII

[![Crates.io](https://img.shields.io/crates/v/yagii.svg)](https://crates.io/crates/yagii)
[![docs.rs](https://docs.rs/yagii/badge.svg)](https://docs.rs/yagii)
[![Build Status](https://travis-ci.org/sadaie/yagii.svg?branch=master)](https://travis-ci.org/sadaie/yagii)
[![GitHub license](https://img.shields.io/github/license/sadaie/yagii.svg)](https://github.com/sadaie/yagii/blob/master/LICENSE)

**YAGII** stands for *Yet Another Github style Identicon Implementation* and is pronounced \[jɐɣi\].

YAGII can be build with nightly rustc only for now.

## Usage

```rust
// If you use Rust edition 2015 you need to write `extern crate`.
// extern crate yagii;
use yagii::{Dimensions, ChunkConfig, generate_identicon};

// Chunk is 70 pixel square.
let chunk_config = ChunkConfig::Square(70);
// 5 chunks square.
let dimensions = Dimensions(5, 5);

let image = generate_identicon("some data".as_bytes(), chunk_config, dimensions);

assert!(image.is_ok());
```

## License
MIT License.