X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=5ebdd421b1e84a1d27dae35268765ab30fafbe11;hb=428a3cfc43dc077a8919d39e15b413c9d097a23a;hp=a9572f9ab92c99ee73bdc7ee1d32cb35f56dc91c;hpb=d50ea665a0176f5173e6dc8ebc261958421394d9;p=enumset.git diff --git a/README.md b/README.md index a9572f9..5ebdd42 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,28 @@ +# enumset + +[![Build Status](https://api.travis-ci.org/Lymia/enumset.svg?branch=master)](https://travis-ci.org/Lymia/enumset) +[![Latest Version](https://img.shields.io/crates/v/enumset.svg)](https://crates.io/crates/enumset) +![Requires rustc 1.31+](https://img.shields.io/badge/rustc-1.31+-red.svg) +[![Rust Documentation](https://img.shields.io/badge/api-rustdoc-blue.svg)](https://docs.rs/enumset) + A library for defining enums that can be used in compact bit sets. +It supports enums up to 128 variants, and has a macro to use these sets in constants. + +See [the documentation](https://docs.rs/enumset) for more information. + +# License + +This project is 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) -It supports enums up to 64 variants on stable Rust, and up to 128 variants on nightly Rust with the `i128` feature enabled, and has a macro to use these sets in constants. +at your option. -[See the documentation for more information.](https://docs.rs/enumset) +### Contribution -This library is dual licenced under the MIT and Apache 2.0 licenses. +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in enumset by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions.