diff --git a/Cargo.toml b/Cargo.toml index badf2eb..b25d8dd 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "hex" -version = "0.4.2" +version = "0.4.3" authors = ["KokaKiwi "] description = "Encoding and decoding data into/from hexadecimal representation." license = "MIT OR Apache-2.0" @@ -12,7 +12,7 @@ keywords = ["no_std", "hex"] categories = ["encoding", "no-std"] [badges] -travis-ci = { repository = "KokaKiwi/rust-hex", branch = "master" } +maintenance = { status = "actively-developed" } [features] default = ["std"] diff --git a/README.md b/README.md index 9d395a8..5dfd4b2 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -hex -=== +# hex + [![Crates.io: hex](https://img.shields.io/crates/v/hex.svg)](https://crates.io/crates/hex) [![Documentation](https://docs.rs/hex/badge.svg)](https://docs.rs/hex) [![Build Status (Github Actions)](https://github.com/KokaKiwi/rust-hex/workflows/Test%20hex/badge.svg?master)](https://github.com/KokaKiwi/rust-hex/actions) @@ -9,6 +9,7 @@ Encoding and decoding data into/from hexadecimal representation. ## Examples Encoding a `String` + ```rust let hex_string = hex::encode("Hello world!"); @@ -16,6 +17,7 @@ println!("{}", hex_string); // Prints "48656c6c6f20776f726c6421" ``` Decoding a `String` + ```rust let decoded_string = hex::decode("48656c6c6f20776f726c6421"); @@ -27,6 +29,7 @@ You can find the [documentation](https://docs.rs/hex) here. ## Installation In order to use this crate, you have to add it under `[dependencies]` to your `Cargo.toml` + ```toml [dependencies] hex = "0.4" @@ -44,17 +47,17 @@ hex = { version = "0.4", default-features = false } ## Features - `std`: - Enabled by default. Add support for Rust's libstd types. + Enabled by default. Add support for Rust's libstd types. - `serde`: - Disabled by default. Add support for `serde` de/serializing library. - See the `serde` module documentation for usage. + Disabled by default. Add support for `serde` de/serializing library. + See the `serde` module documentation for usage. ## 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) +- 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. diff --git a/src/lib.rs b/src/lib.rs index 65278f1..ec48961 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -32,7 +32,7 @@ //! # assert_eq!(hex_string, "48656c6c6f20776f726c6421"); //! ``` -#![doc(html_root_url = "https://docs.rs/hex/0.4.2")] +#![doc(html_root_url = "https://docs.rs/hex/0.4.3")] #![cfg_attr(not(feature = "std"), no_std)] #![cfg_attr(docsrs, feature(doc_cfg))] #![allow(clippy::unreadable_literal)]