# kinetic-protobuf

[![Build Status](https://travis-ci.org/peterdelevoryas/kinetic-protobuf.svg?branch=master)](https://travis-ci.org/peterdelevoryas/kinetic-protobuf)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/peterdelevoryas/kinetic-protobuf/master/LICENSE)
[![Documentation](https://docs.rs/kinetic-protobuf/badge.svg)](https://docs.rs/kinetic-protobuf)
[![](https://img.shields.io/crates/v/kinetic-protobuf.svg)](https://crates.io/crates/kinetic-protobuf)

This library compiles the Kinetic protocol buffer specification to a Rust library using
`rust-protobuf`. Users can simply add the library as a dependency for their projects.
This is not an implementation of a Kinetic client library for Rust: for that, see
[`tokio-kinetic`](https://github.com/peterdelevoryas/tokio-kinetic).

## Usage

In your `Cargo.toml`,

```toml
[dependencies]
kinetic-protobuf = "0.1.2"
```

In your source,

```rust
extern crate kinetic_protobuf;
```

## Licensing

`kinetic-protobuf` is distributed under the terms of the MIT license.
The Kinetic Protocol is licensed under Mozilla Public License 2.0,
and so I have included the Kinetic Protocol source repository,
used to generate this library (specifically the file "kinetic.proto"),
as a submodule for users to have access to.