diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 35 |
1 files changed, 14 insertions, 21 deletions
@@ -1,18 +1,10 @@ # pin-project -[![crates-badge]][crates-url] -[![docs-badge]][docs-url] -[![license-badge]][license] -[![rustc-badge]][rustc-url] - -[crates-badge]: https://img.shields.io/crates/v/pin-project.svg -[crates-url]: https://crates.io/crates/pin-project -[docs-badge]: https://docs.rs/pin-project/badge.svg -[docs-url]: https://docs.rs/pin-project -[license-badge]: https://img.shields.io/badge/license-Apache--2.0%20OR%20MIT-blue.svg -[license]: #license -[rustc-badge]: https://img.shields.io/badge/rustc-1.37+-lightgray.svg -[rustc-url]: https://blog.rust-lang.org/2019/08/15/Rust-1.37.0.html +[](https://crates.io/crates/pin-project) +[](https://docs.rs/pin-project) +[](#license) +[](https://www.rust-lang.org) +[](https://github.com/taiki-e/pin-project/actions?query=workflow%3ACI+branch%3Amaster) A crate for safe and ergonomic [pin-projection]. @@ -25,7 +17,7 @@ Add this to your `Cargo.toml`: pin-project = "1" ``` -The current pin-project requires Rust 1.37 or later. +*Compiler support: requires rustc 1.37+* ## Examples @@ -83,25 +75,26 @@ impl<T, U> Enum<T, U> { [*code like this will be generated*][enum-default-expanded] -See [documentation][docs-url] for more details, and +See [documentation](https://docs.rs/pin-project) for more details, and see [examples] directory for more examples and generated code. [`pin_project`]: https://docs.rs/pin-project/1/pin_project/attr.pin_project.html [enum-default-expanded]: examples/enum-default-expanded.rs [examples]: examples/README.md -[pin-projection]: https://doc.rust-lang.org/nightly/std/pin/index.html#projections-and-structural-pinning +[pin-projection]: https://doc.rust-lang.org/std/pin/index.html#projections-and-structural-pinning [struct-default-expanded]: examples/struct-default-expanded.rs ## Related Projects -* [pin-project-lite]: A lightweight version of pin-project written with declarative macros. +- [pin-project-lite]: A lightweight version of pin-project written with declarative macros. [pin-project-lite]: https://github.com/taiki-e/pin-project-lite ## License -Licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or [MIT license](LICENSE-MIT) at your option. +Licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or +[MIT license](LICENSE-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. +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. |