Add serialize_as_map

[enumset.git] / README.md

diff --git a/README.md b/README.md
index c25b1288d70b171cb48b3bbd80cd6428da8644dd..ffc7db2268f8376a4391ff5b2a33796eed32a713 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,28 @@
+# enumset
+
+[![Build Status](https://github.com/Lymia/enumset/actions/workflows/test.yml/badge.svg)](https://github.com/Lymia/enumset/actions/workflows/test.yml)
+[![Latest Version](https://img.shields.io/crates/v/enumset.svg)](https://crates.io/crates/enumset)
+![Requires rustc 1.36+](https://img.shields.io/badge/rustc-1.36+-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.
+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)
+
+at your option.
 
-[See the documentation for more information.](https://lymia.moe/doc/enumset/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.