Skip to content

Commit fa48318

Browse files
authored
Revise README for HashifyNET updates
Updated README to reflect new features and algorithms in HashifyNET. Signed-off-by: Xen <lordofxen@deskasoft.com>
1 parent 81e0400 commit fa48318

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
HashifyNET
22
=================
33

4-
HashifyNET is a C# library designed to offer a common interface for a wide range of [cryptographic](https://en.wikipedia.org/wiki/List_of_hash_functions#Keyed_cryptographic_hash_functions) and [non-cryptographic](https://en.wikipedia.org/wiki/List_of_hash_functions#Non-cryptographic_hash_functions) hashing algorithms, while also providing built-in implementations of numerous well-known hash functions.
4+
HashifyNET is a CLS-Compliant .NET library designed to offer a common interface for a wide range of [cryptographic](https://en.wikipedia.org/wiki/List_of_hash_functions#Keyed_cryptographic_hash_functions) and [non-cryptographic](https://en.wikipedia.org/wiki/List_of_hash_functions#Non-cryptographic_hash_functions) hashing algorithms, while also providing built-in implementations of numerous well-known hash functions.
55

66
All functionality of the library is tested using [xUnit](https://github.com/xunit/xunit). A primary requirement for each release is 100% code coverage by these tests.
77
All code within the library is commented using Visual Studio-compatible XML comments.
@@ -28,6 +28,9 @@ As an addition, we introduced 11 more hash algorithms, sorted below:
2828
- SM3
2929
- Keccak
3030
- Argon2id
31+
- xxHash3
32+
- xxHash3_128
33+
- RapidHash
3134

3235
> [!NOTE]
3336
> Please check Implementations for the full list of available hash algorithms.
@@ -86,6 +89,8 @@ The following hash functions have been implemented from the most reliable refere
8689
* [Pearson hashing](http://en.wikipedia.org/wiki/Pearson_hashing)
8790
* PearsonBase - Abstract implementation; there is no authoritative implementation
8891
* WikipediaPearson - Concrete implementation, uses values from the Wikipedia article
92+
* [RapidHash](https://github.com/Nicoshev/rapidhash)
93+
* Supports Original, Micro, and Nano modes.
8994
* [SipHash](https://en.wikipedia.org/wiki/SipHash)
9095
* [SM3](https://en.wikipedia.org/wiki/SM3_(hash_function))
9196
* [SpookyHash](http://burtleburtle.net/bob/hash/spooky.html)
@@ -97,6 +102,8 @@ The following hash functions have been implemented from the most reliable refere
97102
* [Whirlpool](https://en.wikipedia.org/wiki/Whirlpool_(hash_function))
98103
* [xxHash](https://code.google.com/p/xxhash/)
99104
* xxHash - Original and 64-bit version.
105+
* xxHash3 - Wraps around System.IO.Hashes.
106+
* xxHash128 - Wraps around System.IO.Hashes.
100107

101108
Usage
102109
-----
@@ -183,3 +190,4 @@ HashifyNET is released under the terms of the MIT license. See [LICENSE](https:/
183190

184191

185192

193+

0 commit comments

Comments
 (0)