summaryrefslogtreecommitdiffstats
path: root/tokio-test/README.md
diff options
context:
space:
mode:
authorLucio Franco <luciofranco14@gmail.com>2019-04-23 23:17:57 -0400
committerCarl Lerche <me@carllerche.com>2019-04-23 20:17:57 -0700
commite5cf0cc717396d8131e3c8825667648fd7f17013 (patch)
treed389306a51b9e5d6b14aada2981f3a4075852489 /tokio-test/README.md
parent62f34e15ce6294f6273c33548772a70d76f2ea61 (diff)
Introduce `tokio-test` crate (#1030)
Diffstat (limited to 'tokio-test/README.md')
-rw-r--r--tokio-test/README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/tokio-test/README.md b/tokio-test/README.md
new file mode 100644
index 00000000..cc737fb4
--- /dev/null
+++ b/tokio-test/README.md
@@ -0,0 +1,36 @@
+# tokio-test
+
+Tokio and Futures based testing utilities
+
+[Documenation](https://docs.rs/tokio-test)
+
+## Usage
+
+First, add this to your `Cargo.toml`:
+
+```toml
+[dev-dependencies]
+tokio-test = "0.1.0"
+```
+
+Next, add this to your crate:
+
+```rust
+#[macro_use]
+extern crate tokio_test;
+```
+
+You can find extensive documentation and examples about how to use this crate
+online at [https://tokio.rs](https://tokio.rs). The [API
+documentation](https://docs.rs/tokio-test) is also a great place to get started
+for the nitty-gritty.
+
+## License
+
+This project is licensed under the [MIT license](LICENSE).
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in Tokio by you, shall be licensed as MIT, without any additional
+terms or conditions.