Skip to content

Commit 77e2321

Browse files
committed
Update package name to XxHashLib and fix README badges
Changed the NuGet package ID from XxHash to XxHashLib in the project file and updated related badges and links in the README. Also removed a redundant NuGet link and cleaned up method signature notes for clarity.
1 parent 1549390 commit 77e2321

2 files changed

Lines changed: 10 additions & 11 deletions

File tree

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
![logo](branding/titlebar.png)
22

3-
[![GitHub license](https://img.shields.io/github/license/emako/XxHash.NET)](https://github.com/emako/XxHash.NET/blob/master/LICENSE) [![NuGet](https://img.shields.io/nuget/v/XxHash.svg)](https://nuget.org/packages/XxHash) [![Actions](https://github.com/emako/XxHash.NET/actions/workflows/library.nuget.yml/badge.svg)](https://github.com/emako/XxHash.NET/actions/workflows/library.nuget.yml)
3+
[![GitHub license](https://img.shields.io/github/license/emako/XxHash.NET)](https://github.com/emako/XxHash.NET/blob/master/LICENSE) [![NuGet](https://img.shields.io/nuget/v/XxHashLib.svg)](https://nuget.org/packages/XxHashLib) [![Actions](https://github.com/emako/XxHash.NET/actions/workflows/library.nuget.yml/badge.svg)](https://github.com/emako/XxHash.NET/actions/workflows/library.nuget.yml)
44

55
# XxHash.NET
66

@@ -131,8 +131,8 @@ ulong hash = XxHash.XxHash64(stream, bufferSize: 8192);
131131
|--------|-------------|-------------|
132132
| `XxHash32(string)` | `uint` | Hash a string |
133133
| `XxHash32(byte[])` | `uint` | Hash a byte array |
134-
| `XxHash32(ReadOnlySpan<byte>)` | `uint` | Hash a byte span* |
135-
| `XxHash32(ReadOnlySpan<char>)` | `uint` | Hash a char span* |
134+
| `XxHash32(ReadOnlySpan<byte>)` | `uint` | Hash a byte span |
135+
| `XxHash32(ReadOnlySpan<char>)` | `uint` | Hash a char span |
136136
| `XxHash32(Stream, int)` | `uint` | Hash a stream with optional buffer size |
137137
| `XxHash32s(...)` | `int` | Signed versions of above methods |
138138

@@ -142,8 +142,8 @@ ulong hash = XxHash.XxHash64(stream, bufferSize: 8192);
142142
|--------|-------------|-------------|
143143
| `XxHash64(string)` | `ulong` | Hash a string |
144144
| `XxHash64(byte[])` | `ulong` | Hash a byte array |
145-
| `XxHash64(ReadOnlySpan<byte>)` | `ulong` | Hash a byte span* |
146-
| `XxHash64(ReadOnlySpan<char>)` | `ulong` | Hash a char span* |
145+
| `XxHash64(ReadOnlySpan<byte>)` | `ulong` | Hash a byte span |
146+
| `XxHash64(ReadOnlySpan<char>)` | `ulong` | Hash a char span |
147147
| `XxHash64(Stream, int)` | `ulong` | Hash a stream with optional buffer size |
148148
| `XxHash64s(...)` | `long` | Signed versions of above methods |
149149

@@ -153,8 +153,8 @@ ulong hash = XxHash.XxHash64(stream, bufferSize: 8192);
153153
|--------|-------------|-------------|
154154
| `XxHash3(string)` | `ulong` | Hash a string |
155155
| `XxHash3(byte[])` | `ulong` | Hash a byte array |
156-
| `XxHash3(ReadOnlySpan<byte>)` | `ulong` | Hash a byte span* |
157-
| `XxHash3(ReadOnlySpan<char>)` | `ulong` | Hash a char span* |
156+
| `XxHash3(ReadOnlySpan<byte>)` | `ulong` | Hash a byte span |
157+
| `XxHash3(ReadOnlySpan<char>)` | `ulong` | Hash a char span |
158158
| `XxHash3(Stream, int)` | `ulong` | Hash a stream with optional buffer size |
159159
| `XxHash3s(...)` | `long` | Signed versions of above methods |
160160

@@ -164,8 +164,8 @@ ulong hash = XxHash.XxHash64(stream, bufferSize: 8192);
164164
|--------|-------------|-------------|
165165
| `XxHash128(string)` | `Hash128` | Hash a string |
166166
| `XxHash128(byte[])` | `Hash128` | Hash a byte array |
167-
| `XxHash128(ReadOnlySpan<byte>)` | `Hash128` | Hash a byte span* |
168-
| `XxHash128(ReadOnlySpan<char>)` | `Hash128` | Hash a char span* |
167+
| `XxHash128(ReadOnlySpan<byte>)` | `Hash128` | Hash a byte span |
168+
| `XxHash128(ReadOnlySpan<char>)` | `Hash128` | Hash a char span |
169169
| `XxHash128(Stream, int)` | `Hash128` | Hash a stream with optional buffer size |
170170

171171
\* *Available on .NET Standard 2.1+ and .NET Core 2.1+*
@@ -282,5 +282,4 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
282282

283283
- [xxHash Official Repository](https://github.com/Cyan4973/xxHash)
284284
- [xxHash Algorithm Specification](https://github.com/Cyan4973/xxHash/blob/dev/doc/xxhash_spec.md)
285-
- [NuGet Package](https://www.nuget.org/packages/XxHash/)
286285

src/System.IO.Hashing.XxHash.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
66
<LangVersion>preview</LangVersion>
77
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
8-
<PackageId>XxHash</PackageId>
8+
<PackageId>XxHashLib</PackageId>
99
<AssemblyVersion>1.0.0</AssemblyVersion>
1010
<FileVersion>1.0.0</FileVersion>
1111
<Version>$(VersionPrefix)1.0.0</Version>

0 commit comments

Comments
 (0)