Skip to content

Commit 6089f59

Browse files
authored
Update Readme
Signed-off-by: Xen <lordofxen@deskasoft.com>
1 parent c0871ee commit 6089f59

File tree

1 file changed

+16
-20
lines changed

1 file changed

+16
-20
lines changed

README.md

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
> [!IMPORTANT]
22
> [HashifyNET Command Line Interface](https://github.com/Deskasoft/HashifyNETCLI) is now available!
33
4-
5-
HashifyNET
4+
HashifyNET<img width="32" height="32" src="https://github.com/Deskasoft/HashifyNET/blob/main/logo.png" alt="logo" />
65
==========
76

87
HashifyNET is a CLS-Compliant, platform-independent .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.
98

10-
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.
9+
All library functionality is tested using [xUnit](https://github.com/xunit/xunit). A primary requirement for each release is 100% code coverage by these tests.
1110
All code within the library is commented using Visual Studio-compatible XML comments.
1211

1312
Should you require assistance or wish to join our community, please use the following link to access our Discord server: https://discord.gg/PrKery9
1413

1514
Differences
1615
-----------
17-
This library is the successor to https://github.com/Deskasoft/Data.HashFunction. While keeping the API structure *mostly* the same, the biggest change this library brings is the clearance of the dependency overhaul previously caused by Data.HashFunction.
18-
Every hash algorithm is now collected under one single assembly and package named HashifyNET, and all of the namespaces are shortened to HashifyNet.
16+
This library is the successor to https://github.com/Deskasoft/Data.HashFunction. The principal modification introduced by this library, while preserving substantial continuity in the API structure, is the rectification of the dependency burden previously incurred by `Data.HashFunction`.
17+
All hash algorithms are now centralized within a singular assembly and corresponding package, HashifyNET.
18+
Furthermore, the associated namespaces have been concisely streamlined to HashifyNet.
1919

2020
The former factory-based implementation, which assigned a unique factory to each hash function, has been superseded by a more modular and centralized factory.
2121
This new model provides superior accessibility and efficiency.
2222

23-
As an addition, we introduced 30 more hash algorithms, sorted below:
23+
In addition, we introduced 33 more hash algorithms, sorted below:
2424
- Adler32
2525
- Blake3
2626
- Gost
@@ -33,6 +33,9 @@ As an addition, we introduced 30 more hash algorithms, sorted below:
3333
- Keccak
3434
- Argon2id
3535
- RapidHash
36+
- T1HA0
37+
- T1HA1
38+
- T1HA2
3639

3740
Implementations introduced by wrapping existing .NET implementations:
3841
- xxHash3
@@ -60,7 +63,7 @@ Implementations introduced by wrapping existing .NET implementations:
6063
### Demo
6164
You can see a working example of HasihfyNET using Blazor right [here](https://deskasoft.github.io/HashifyNETDemo/).
6265
You can also click on the showcase below to go to the demo.
63-
[<img width="1280" height="720" alt="hashifynet_demo_short" src="https://github.com/user-attachments/assets/2bd7c477-88d6-4616-a9cb-5d24cb9d4be5" />](https://deskasoft.github.io/HashifyNETDemo/)
66+
[<img width="1280" height="720" alt="hashifynet_demo_short" src="https://github.com/Deskasoft/HashifyNETDemo/blob/main/hashifynet_demo_short.png" />](https://deskasoft.github.io/HashifyNETDemo/)
6467

6568
### NuGet
6669
You can directly bind HashifyNET to your project through NuGet below:
@@ -123,6 +126,10 @@ The following hash functions have been implemented from the most reliable refere
123126
* [Tiger](https://en.wikipedia.org/wiki/Tiger_(hash_function))
124127
* Tiger - Original
125128
* Tiger2 - The padding at the beginning of the algorithm changes from 0x01 to 0x80. This is the only difference from the original Tiger algorithm.
129+
* [T1HA](https://github.com/erthink/t1ha)
130+
* T1HA0 - 64-bit Little-Endian version.
131+
* T1HA1 - 64-bit Little-Endian version.
132+
* T1HA2 - 64-bit and 128-bit Little-Endian versions.
126133
* [Whirlpool](https://en.wikipedia.org/wiki/Whirlpool_(hash_function))
127134
* [xxHash](https://code.google.com/p/xxhash/)
128135
* xxHash - Original and 64-bit version.
@@ -246,8 +253,8 @@ foreach (IHashFunctionBase function in functions)
246253
}
247254
```
248255

249-
There are a lot more changes made to the library, and feel free to explore them by adding to your project.
250-
We'd love to see what you are going to do or have done with our library, so feel free to share them with us at https://discord.gg/PrKery9.
256+
A significant number of additional modifications have been implemented within the library. We encourage you to integrate these updates into your project and explore them fully.
257+
We are eager to observe the innovative applications you develop, or have already developed, using our library. Please feel free to share your work with us by joining our community at: https://discord.gg/PrKery9.
251258

252259
Please visit [wiki/Release-Notes](https://github.com/Deskasoft/HashifyNET/wiki/Release-Notes) for more information about usage examples and the latest features available.
253260

@@ -282,14 +289,3 @@ License
282289
-------
283290

284291
HashifyNET is released under the terms of the MIT license. See [LICENSE](https://github.com/deskasoft/HashifyNET/blob/master/LICENSE) for more information or see http://opensource.org/licenses/MIT.
285-
286-
287-
288-
289-
290-
291-
292-
293-
294-
295-

0 commit comments

Comments
 (0)