README.md(s): fix GitHub actions links

...and some other additional links

Author: tony-iqlusion

README.md

@@ -1,4 +1,4 @@
-# iqlusion crates <a href="https://www.iqlusion.io"><img src="https://storage.googleapis.com/iqlusion-production-web/img/logo/iqlusion-rings-sm.png" alt="iqlusion" width="24" height="24"></a> <a href="https://crates.io">📦</a>
+# iqlusion crates <a href="https://crates.io"><img src="https://storage.googleapis.com/iqlusion-production-web/github/companion-crate.png" alt="crate" width="24" height="24"></a> <a href="https://www.iqlusion.io"><img src="https://storage.googleapis.com/iqlusion-production-web/img/logo/iqlusion-rings-sm.png" alt="iqlusion" width="24" height="24"></a>
 
 [![Apache 2.0 Licensed][license-image]][license-link]
 ![MSRV][msrv-image]

anomaly/README.md

@@ -80,7 +80,7 @@ without any additional terms or conditions.
 [rustc-image]: https://img.shields.io/badge/rustc-1.36+-blue.svg
 [safety-image]: https://img.shields.io/badge/unsafe-forbidden-success.svg
 [safety-link]: https://github.com/rust-secure-code/safety-dance/
-[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg
+[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg?branch=develop&event=push
 [build-link]: https://github.com/iqlusioninc/crates/actions
 [gitter-image]: https://badges.gitter.im/iqlusioninc/community.svg
 [gitter-link]: https://gitter.im/iqlusioninc/community

canonical-path/README.md

@@ -55,7 +55,7 @@ without any additional terms or conditions.
 [license-image]: https://img.shields.io/badge/license-Apache2.0-blue.svg
 [license-link]: https://github.com/iqlusioninc/crates/blob/develop/LICENSE
 [rustc-image]: https://img.shields.io/badge/rustc-1.39+-blue.svg
-[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg
+[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg?branch=develop&event=push
 [build-link]: https://github.com/iqlusioninc/crates/actions
 [gitter-image]: https://badges.gitter.im/iqlusioninc/community.svg
 [gitter-link]: https://gitter.im/iqlusioninc/community

harp/README.md

@@ -57,7 +57,7 @@ without any additional terms or conditions.
 [rustc-image]: https://img.shields.io/badge/rustc-1.39+-blue.svg
 [safety-image]: https://img.shields.io/badge/unsafe-forbidden-success.svg
 [safety-link]: https://github.com/rust-secure-code/safety-dance/
-[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg
+[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg?branch=develop&event=push
 [build-link]: https://github.com/iqlusioninc/crates/actions
 [gitter-image]: https://badges.gitter.im/iqlusioninc/community.svg
 [gitter-link]: https://gitter.im/iqlusioninc/community

hkd32/README.md

@@ -53,7 +53,7 @@ without any additional terms or conditions.
 [license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
 [license-link]: https://github.com/iqlusioninc/crates/blob/develop/LICENSE
 [rustc-image]: https://img.shields.io/badge/rustc-1.39+-blue.svg
-[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg
+[build-image]: hhttps://github.com/iqlusioninc/crates/workflows/Rust/badge.svg?branch=develop&event=push
 [build-link]: https://github.com/iqlusioninc/crates/actions
 [gitter-image]: https://badges.gitter.im/iqlusioninc/community.svg
 [gitter-link]: https://gitter.im/iqlusioninc/community

secrecy/README.md

@@ -64,7 +64,7 @@ without any additional terms or conditions.
 [rustc-image]: https://img.shields.io/badge/rustc-1.39+-blue.svg
 [safety-image]: https://img.shields.io/badge/unsafe-forbidden-success.svg
 [safety-link]: https://github.com/rust-secure-code/safety-dance/
-[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg
+[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg?branch=develop&event=push
 [build-link]: https://github.com/iqlusioninc/crates/actions
 [gitter-image]: https://badges.gitter.im/iqlusioninc/community.svg
 [gitter-link]: https://gitter.im/iqlusioninc/community

subtle-encoding/README.md

@@ -51,7 +51,7 @@ toplevel directory of this repository or [LICENSE-MIT] for details.
 [rustc-image]: https://img.shields.io/badge/rustc-1.39+-blue.svg
 [safety-image]: https://img.shields.io/badge/unsafe-forbidden-success.svg
 [safety-link]: https://github.com/rust-secure-code/safety-dance/
-[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg
+[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg?branch=develop&event=push
 [build-link]: https://github.com/iqlusioninc/crates/actions
 [gitter-image]: https://badges.gitter.im/iqlusioninc/community.svg
 [gitter-link]: https://gitter.im/iqlusioninc/community

tai64/README.md

@@ -55,7 +55,7 @@ without any additional terms or conditions.
 [rustc-image]: https://img.shields.io/badge/rustc-1.39+-blue.svg
 [safety-image]: https://img.shields.io/badge/unsafe-forbidden-success.svg
 [safety-link]: https://github.com/rust-secure-code/safety-dance/
-[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg
+[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg?branch=develop&event=push
 [build-link]: https://github.com/iqlusioninc/crates/actions
 [gitter-image]: https://badges.gitter.im/iqlusioninc/community.svg
 [gitter-link]: https://gitter.im/iqlusioninc/community

vint64/README.md

@@ -15,20 +15,21 @@ little endian integers which optimizes for simplicity and performance.
 
 ## About
 
-This crate implements a variable-length encoding for 64-bit little
-endian integers with a number of properties which make it superior in every
-way to other variable-length integer encodings like
-[LEB128], SQLite "Varuints" or CBOR:
+This crate implements a variable-length encoding for 64-bit little endian
+integers with a number of properties which make it superior in almost every
+way to other variable-length integer encodings like [LEB128], SQLite "Varuints",
+or CBOR:
 
 - Capable of expressing the full 64-bit integer range with a maximum of 9-bytes
+- Provides the most compact encoding possible for every value in range
 - No loops involved in decoding: just (unaligned) loads, masks, and shifts
-- No complex branch-heavy logic - decoding is CTZ + shifts and sanity checks
+- No complex branch-heavy logic: decoding is CTZ + shifts and sanity checks
 - Total length of a `vint64` can be determined via the first byte alone
 
 Some precedent for this sort of encoding can be found in the
 [Extensible Binary Meta Language] (used by e.g. the [Matroska]
 media container format), however note that the specific type of "vint"
-used by this format still requires a loop to decode.
+used by that format still requires a loop to decode.
 
 ## License
 
@@ -54,16 +55,16 @@ without any additional terms or conditions.
 
 [//]: # (badges)
 
-[crate-image]: https://img.shields.io/crates/v/vint.svg
-[crate-link]: https://crates.io/crates/vint
-[docs-image]: https://docs.rs/vint/badge.svg
-[docs-link]: https://docs.rs/vint/
+[crate-image]: https://img.shields.io/crates/v/vint64.svg
+[crate-link]: https://crates.io/crates/vint64
+[docs-image]: https://docs.rs/vint64/badge.svg
+[docs-link]: https://docs.rs/vint64/
 [license-image]: https://img.shields.io/badge/license-Apache2.0-blue.svg
 [license-link]: https://github.com/iqlusioninc/crates/blob/develop/LICENSE
 [rustc-image]: https://img.shields.io/badge/rustc-1.39+-blue.svg
 [safety-image]: https://img.shields.io/badge/unsafe-forbidden-success.svg
 [safety-link]: https://github.com/rust-secure-code/safety-dance/
-[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg
+[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg?branch=develop&event=push
 [build-link]: https://github.com/iqlusioninc/crates/actions
 [gitter-image]: https://badges.gitter.im/iqlusioninc/community.svg
 [gitter-link]: https://gitter.im/iqlusioninc/community

vint64/src/lib.rs

@@ -2,20 +2,21 @@
 //!
 //! # About
 //!
-//! This crate implements a variable-length encoding for 64-bit little
-//! endian integers with a number of properties which make it superior in every
-//! way to other variable-length integer encodings like
-//! [LEB128], SQLite "Varuints" or CBOR:
+//! This crate implements a variable-length encoding for 64-bit little endian
+//! integers with a number of properties which make it superior in almost every
+//! way to other variable-length integer encodings like [LEB128], SQLite "Varuints",
+//! or CBOR:
 //!
 //! - Capable of expressing the full 64-bit integer range with a maximum of 9-bytes
+//! - Provides the most compact encoding possible for every value in range
 //! - No loops involved in decoding: just (unaligned) loads, masks, and shifts
-//! - No complex branch-heavy logic - decoding is CTZ + shifts and sanity checks
+//! - No complex branch-heavy logic: decoding is CTZ + shifts and sanity checks
 //! - Total length of a `vint64` can be determined via the first byte alone
 //!
 //! Some precedent for this sort of encoding can be found in the
 //! [Extensible Binary Meta Language] (used by e.g. the [Matroska]
 //! media container format), however note that the specific type of "vint"
-//! used by this format still requires a loop to decode.
+//! used by that format still requires a loop to decode.
 //!
 //! # Usage
 //!
@@ -24,6 +25,10 @@
 //! let encoded = vint64::encode(42);
 //! assert_eq!(encoded.as_ref(), &[0x55]);
 //!
+//! // Get the length of a `vint64` from its first byte.
+//! // NOTE: this is inclusive of the first byte itself.
+//! let encoded_len = vint64::length_hint(encoded.as_ref()[0]);
+//!
 //! // Decode an encoded vint64 with trailing data
 //! let mut slice: &[u8] = &[0x55, 0xde, 0xad, 0xbe, 0xef];
 //! let decoded = vint64::decode(&mut slice).unwrap();
@@ -119,7 +124,9 @@ impl TryFrom<&[u8]> for Vint64 {
     }
 }
 
-/// Get the length of a `vint64` from the first byte
+/// Get the length of a `vint64` from the first byte.
+///
+/// NOTE: The returned value is inclusive of the first byte itself.
 pub fn length_hint(byte: u8) -> usize {
     byte.trailing_zeros() as usize + 1
 }