From 129ada1f31848d56aa57eb5eb1230bc83d660b40 Mon Sep 17 00:00:00 2001 From: "Stephen M. Coakley" Date: Sat, 24 Feb 2018 14:26:40 -0600 Subject: [PATCH] update readme --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index eb7d7f9..1eee7b5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,19 @@ # Ringtail -Efficient ring buffer for byte buffers, FIFO queues, and SPSC channels. +Efficient ring buffer implementations for byte buffers, FIFO queues, and SPSC channels. +[![Crates.io](https://img.shields.io/crates/v/ringtail.svg)](https://crates.io/crates/ringtail) +[![Documentation](https://docs.rs/ringtail/badge.svg)](https://docs.rs/ringtail) ![License](https://img.shields.io/badge/license-MIT-blue.svg) +[Documentation](https://docs.rs/ringtail) + +## Installation +Add this to your Cargo.toml file: + +```toml +[dependencies] +ringtail = "0.1" +``` + ## License This library is licensed under the MIT license. See the [LICENSE](LICENSE) file for details.