![banner](assets/banner.png)

# Libyobicash
[![Travis branch](https://img.shields.io/travis/yobicash/libyobicash/master.svg)](https://travis-ci.org/yobicash/libyobicash)
[![Coveralls github branch](https://img.shields.io/coveralls/github/yobicash/libyobicash/master.svg)](https://coveralls.io/github/yobicash/libyobicash?branch=master)
[![Crates.io](https://img.shields.io/crates/v/libyobicash.svg)](https://crates.io/crates/libyobicash)
[![Docs.rs](https://docs.rs/libyobicash/badge.svg)](https://docs.rs/libyobicash)
[![Crates.io](https://img.shields.io/crates/l/libyobicash.svg)]()

The [Yobicash](https://yobicash.org) cryptocurrency library.

*NOTES*:

- This is still an alpha: use with caution.
- Some tests may be still missing.
- The API may change.

## Table of Contents

- [Install](#install)
- [Usage](#usage)
- [Maintainers](#maintainers)
- [License](#license)
- [Contributing](#contributing)

## Install

To install libyobicash add in your Cargo.toml:

```toml
# Cargo.toml

[dependencies]
libyobicash = "^0.3"
```

and in the root of your crate:

```rust
//main.rs

extern crate libyobicash;
```

## Usage

Look at the [documentation](https://docs.rs/libyobicash) or at the tests for guidance.

## Maintainers

[@chritchens](https://github.com/chritchens)

## License

This project is license under either of

 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
   http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license ([LICENSE-MIT](LICENSE-MIT) or
   http://opensource.org/licenses/MIT)

at your option.

## Contributing

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in libyobicash by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.