From 75f7a39b9f3ccb186be051478b6933133918a178 Mon Sep 17 00:00:00 2001 From: Avril Date: Mon, 19 Oct 2020 17:30:34 +0100 Subject: [PATCH] update readme --- Cargo.toml | 3 ++- README.md | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 34adfb8..e929780 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,11 +1,12 @@ [package] name = "refset" description = "A non-owning HashSet" +repository = "https://git.flanchan.moe/flanchan/refset" keywords = ["hash", "set", "reference"] version = "0.1.0" authors = ["Avril "] edition = "2018" -license= "mit" +license= "MIT" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/README.md b/README.md index 193d529..9242c4f 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ Even when `Clone` is required to insert into `HashSet`, it can be ~10x faster fo | owning_ints | Inserts `u32` into `HashSet` by copy | ~937 ns/iter | | non_owning_ints | Inserts `&u32` into `HashRefSet` by reference | ~31,089 ns/iter | -# When to use over `HashSet` +## When to use over `HashSet` * The type you're inserting needs to be both in the set and moved elsewhere. (see exmaple) * Simply using `Clone` to insert a copy of the item into a `HashSet` is not possible (non-`Clone` type) or is a significantly heavy operation. (see benchmarks) * The fallibility of potential (albeing extremely unlikely) collisions of the SHA512 algorithm is not a concern