diff --git a/README.md b/README.md new file mode 100644 index 000000000..8b0beea2d --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# tokio-signal + +An implementation of Unix signal handling for Tokio + +[![Build Status](https://travis-ci.org/alexcrichton/tokio-signal.svg?branch=master)](https://travis-ci.org/tokio-rs/tokio-signal) + +[Documentation](https://alexcrichton.github.io/tokio-signal) + +## Usage + +First, add this to your `Cargo.toml`: + +```toml +[dependencies] +tokio-signal = { git = "https://github.com/alexcrichton/tokio-signal" } +``` + +Next, add this to your crate: + +```rust +extern crate tokio_signal; +``` + +# License + +`tokio-signal` is primarily distributed under the terms of both the MIT +license and the Apache License (Version 2.0), with portions covered by various +BSD-like licenses. + +See LICENSE-APACHE, and LICENSE-MIT for details. + +