From 4c72f34029ffa48279a48e357d19e155fa62b236 Mon Sep 17 00:00:00 2001 From: Olivier Giniaux Date: Mon, 27 May 2024 23:26:34 +0200 Subject: [PATCH] Update readme --- README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 08baf02..c1a3ba0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # GxHash [![Build & Test](https://github.com/ogxd/gxhash/actions/workflows/build_test.yml/badge.svg)](https://github.com/ogxd/gxhash/actions/workflows/build_test.yml) +[![Cross Compile](https://github.com/ogxd/gxhash/actions/workflows/cross_compile.yml/badge.svg)](https://github.com/ogxd/gxhash/actions/workflows/cross_compile.yml) +[![Rust Version Compatibility](https://github.com/ogxd/gxhash/actions/workflows/rust_version.yml/badge.svg)](https://github.com/ogxd/gxhash/actions/workflows/rust_version.yml) GxHash is a [**blazingly fast**](#performance) and [**robust**](#robustness) non-cryptographic hashing algorithm. @@ -15,12 +17,6 @@ println!(" 32-bit hash: {:x}", gxhash::gxhash32(&bytes, seed)); println!(" 64-bit hash: {:x}", gxhash::gxhash64(&bytes, seed)); println!("128-bit hash: {:x}", gxhash::gxhash128(&bytes, seed)); ``` -Used in `HashMap`/`HashSet`: -```rust -// Type alias for HashSet:: -let mut hashset = gxhash::GxHashSet::default(); -hashset.insert("hello world"); -``` GxHash provides an implementation of the [`Hasher`](core::hash::Hasher) trait. For convenience, this crate also provides the type aliases `gxhash::HashMap` and `gxhash::HashSet`.