diff --git a/Cargo.toml b/Cargo.toml index c89aee7..f270498 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -5,6 +5,7 @@ authors = ["Parity Technologies "] license = "Apache-2.0 OR MIT" description = "Multiplexer over reliable, ordered connections" repository = "https://github.com/paritytech/yamux" +readme = "README.md" [dependencies] bytes = "0.4" diff --git a/README.md b/README.md new file mode 100644 index 0000000..f1cd244 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Yamux + +A stream multiplexer over reliable, ordered connections such as TCP/IP. +Implements https://github.com/hashicorp/yamux/blob/master/spec.md + +## License + +Licensed under either of + + * 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 +for inclusion in the work by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions.