Files
tokio/README.md
T

49 lines
1.4 KiB
Markdown
Raw Normal View History

2016-08-26 14:30:46 -07:00
# tokio-core
2016-08-05 16:21:56 -07:00
2016-08-26 14:30:46 -07:00
Core I/O and event loop abstraction for asynchronous I/O in Rust built on
`futures` and `mio`.
2016-08-05 16:21:56 -07:00
2016-08-26 14:30:46 -07:00
[![Build Status](https://travis-ci.org/tokio-rs/tokio-core.svg?branch=master)](https://travis-ci.org/tokio-rs/tokio-core)
2016-08-26 14:57:55 -07:00
[![Build status](https://ci.appveyor.com/api/projects/status/caxmxbg8181kk9mq/branch/master?svg=true)](https://ci.appveyor.com/project/carllerche/tokio-core)
2016-08-05 16:21:56 -07:00
2017-01-09 16:40:16 -08:00
[Documentation](https://docs.rs/tokio-core)
2016-08-05 16:21:56 -07:00
2017-01-11 09:14:50 -08:00
[Tutorial](https://tokio.rs/)
2016-08-05 16:21:56 -07:00
## Usage
First, add this to your `Cargo.toml`:
```toml
[dependencies]
2016-09-09 18:15:15 -07:00
tokio-core = "0.1"
2016-08-05 16:21:56 -07:00
```
Next, add this to your crate:
```rust
2017-10-24 16:30:16 -07:00
extern crate tokio;
2016-08-05 16:21:56 -07:00
```
2017-01-11 09:14:50 -08:00
You can find extensive documentation and examples about how to use this crate
online at [https://tokio.rs](https://tokio.rs) as well as the `examples` folder
in this repository. The [API documentation](https://docs.rs/tokio-core) is also
a great place to get started for the nitty-gritty.
2016-08-08 23:18:49 -07:00
# License
This project is licensed under either of
2016-08-08 23:18:49 -07:00
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
http://opensource.org/licenses/MIT)
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
2017-11-02 16:01:42 -04:00
for inclusion in tokio by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.