# Octavo

[![Join the chat at https://gitter.im/libOctavo/octavo](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/libOctavo/octavo?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![Crates.io](https://img.shields.io/crates/v/octavo.svg?style=flat-square)](https://crates.io/crates/octavo)
[![License](https://img.shields.io/crates/l/octavo.svg?style=flat-square)](LICENSE)
[![Build Status](https://img.shields.io/travis/libOctavo/octavo.svg?style=flat-square)](https://travis-ci.org/libOctavo/octavo)
[![Coverage Status](https://img.shields.io/coveralls/libOctavo/octavo.svg?style=flat-square)](https://coveralls.io/github/libOctavo/octavo?branch=master)
[![GetBadges Game](https://liboctavo-octavo.getbadges.io/shield/company/liboctavo-octavo)](https://getbadges.io/?ref=shield-game)
[![Gratipay](https://img.shields.io/gratipay/liboctavo.svg?style=flat-square)](https://gratipay.com/liboctavo/)

<p align="center">
  <a href="http://github.com/libOctavo/octavo">
    <img alt="Octavo" width="300" src="https://raw.githubusercontent.com/libOctavo/octavo/master/docs/logo.png">
  </a>
</p>

Highly modular & configurable hash & crypto library written in pure Rust.

## Installation

```toml
[dependencies]
octavo = { git = "https://github.com/libOctavo/octavo" }
```

**WARNING!!!** Octavo is on very early stage of development. There is hell lot
of issues and vulnerabilities to enormous kind of attacks! Do not use in
production code (yet)!

## Contributing

You can help with this project in 3 ways:

1. Help me code this up! Just fork, create branch, code & pull-request. Yay!
2. Audit code or use it. If you find bug just fill the issue, it is great help also.
3. Support us at [Gratipay](https://gratipay.com/liboctavo/).

## Full disclosure

If you find security bug then contact me via mail <lukasz@niemier.pl> using
mine [PGP key][pgp]

## Licence

Check [LICENSE](LICENSE) file.

[pgp]: docs/keys/hauleth.asc