README.md
1# futures-rs
2
3This library is an implementation of **zero-cost futures** in Rust.
4
5[](https://github.com/rust-lang/futures-rs/actions)
6[](https://crates.io/crates/futures)
7
8[Documentation](https://docs.rs/futures)
9
10[Tutorial](https://tokio.rs/docs/getting-started/futures/)
11
12## Usage
13
14First, add this to your `Cargo.toml`:
15
16```toml
17[dependencies]
18futures = "0.1.26"
19```
20
21Next, add this to your crate:
22
23```rust
24extern crate futures;
25
26use futures::Future;
27```
28
29For more information about how you can use futures with async I/O you can take a
30look at [https://tokio.rs](https://tokio.rs) which is an introduction to both
31the Tokio stack and also futures.
32
33### Feature `use_std`
34
35`futures-rs` works without the standard library, such as in bare metal environments.
36However, it has a significantly reduced API surface. To use `futures-rs` in
37a `#[no_std]` environment, use:
38
39```toml
40[dependencies]
41futures = { version = "0.1.26", default-features = false }
42```
43
44# License
45
46This project is licensed under either of
47
48 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
49 http://www.apache.org/licenses/LICENSE-2.0)
50 * MIT license ([LICENSE-MIT](LICENSE-MIT) or
51 http://opensource.org/licenses/MIT)
52
53at your option.
54
55### Contribution
56
57Unless you explicitly state otherwise, any contribution intentionally submitted
58for inclusion in Futures by you, as defined in the Apache-2.0 license, shall be
59dual licensed as above, without any additional terms or conditions.
60
){kind=link}