diff options
Diffstat (limited to 'third_party/rust/futures-cpupool/README.md')
-rw-r--r-- | third_party/rust/futures-cpupool/README.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/third_party/rust/futures-cpupool/README.md b/third_party/rust/futures-cpupool/README.md new file mode 100644 index 0000000000..b022994fb5 --- /dev/null +++ b/third_party/rust/futures-cpupool/README.md @@ -0,0 +1,36 @@ +# futures-cpupool + +A library for creating futures representing work happening concurrently on a +dedicated thread pool. + +[![Build Status](https://travis-ci.org/alexcrichton/futures-rs.svg?branch=master)](https://travis-ci.org/alexcrichton/futures-rs) +[![Build status](https://ci.appveyor.com/api/projects/status/yl5w3ittk4kggfsh?svg=true)](https://ci.appveyor.com/project/alexcrichton/futures-rs) + +[Documentation](https://docs.rs/futures-cpupool) + +## Usage + +First, add this to your `Cargo.toml`: + +```toml +[dependencies] +futures = "0.1" +futures-cpupool = "0.1" +``` + +Next, add this to your crate: + +```rust +extern crate futures; +extern crate futures_cpupool; + +use futures_cpupool::CpuPool; +``` + +# License + +`futures-cpupool` 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. |