Skip to content

Commit

Permalink
Fix spacing for nuget description
Browse files Browse the repository at this point in the history
  • Loading branch information
Kermalis committed Aug 30, 2022
1 parent f7581f8 commit 9b04ae5
Showing 1 changed file with 15 additions and 19 deletions.
34 changes: 15 additions & 19 deletions Source/EndianBinaryIO.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -16,31 +16,27 @@
<Version>2.0.0</Version>
<RepositoryUrl>https://github.com/Kermalis/EndianBinaryIO</RepositoryUrl>
<RepositoryType>git</RepositoryType>
<Description>
This .NET library provides a simple API to read/write bytes from/to streams and spans using user-specified endianness.
By default, supported types include primitives, enums, arrays, strings, and some common .NET struct types.
Objects can also be read/written from/to streams via reflection and attributes.
The developer can use the API even if their target behavior or data is not directly supported by using the IBinarySerializable interface, inheritting from the reader/writer, or using the manual Span methods without streams.
Performance is the focus when not using reflection; no allocations unless absolutely necessary!
<Description>This .NET library provides a simple API to read/write bytes from/to streams and spans using user-specified endianness.
By default, supported types include primitives, enums, arrays, strings, and some common .NET struct types.
Objects can also be read/written from/to streams via reflection and attributes.
The developer can use the API even if their target behavior or data is not directly supported by using the IBinarySerializable interface, inheritting from the reader/writer, or using the manual Span methods without streams.
Performance is the focus when not using reflection; no allocations unless absolutely necessary!

Project URL and Samples ― https://github.com/Kermalis/EndianBinaryIO
</Description>
Project URL and Samples ― https://github.com/Kermalis/EndianBinaryIO</Description>
<PackageProjectUrl>https://github.com/Kermalis/EndianBinaryIO</PackageProjectUrl>
<NeutralLanguage>en-001</NeutralLanguage>
<PackageTags>Serialization;Reflection;Endianness;LittleEndian;BigEndian;EndianBinaryIO</PackageTags>
<PackageReadmeFile>README.md</PackageReadmeFile>
<PackageLicenseFile>LICENSE.md</PackageLicenseFile>
<PackageReleaseNotes>
* Rewritten with Span&lt;T&gt; and performance in mind. No allocations unless absolutely necessary
* The compiler will now inline certain methods. For example, ReadEnum&lt;TEnum&gt;() will only include code that will be executed for the given enum size. So passing a TEnum that is the size of a byte will condense down to just a ReadByte() call with no size/type checks
* Implemented reading and writing for Half, DateOnly, TimeOnly, Vector2, Vector3, Vector4, Quaternion, and Matrix4x4
* Removed bloated overloads (with array offset/count, alternate Encoding/BooleanSize, null termination, etc.). The reader/writer now respects its state (such as whether to use ASCII, and which BooleanSize to use) which you can change at any time
* decimal int order now matches with .net APIs
* Removed EndianBitConverter in favor of EndianBinaryPrimitives, which has similar API while using modern programming like Span&lt;T&gt;
* API uses nullable notations
* You can now ReadObject() and WriteObject() with primitives and other supported types like DateTime, Vector3, etc.
* Removed Encoding usage. The whole thing was very complicated before, and it barely functioned. Now you have ASCII and .net (UTF16-LE) support by default, and can add your own requirements either by extension methods or inheriting the reader/writer
</PackageReleaseNotes>
<PackageReleaseNotes>* Rewritten with Span&lt;T&gt; and performance in mind. No allocations unless absolutely necessary
* The compiler will now inline certain methods. For example, ReadEnum&lt;TEnum&gt;() will only include code that will be executed for the given enum size. So passing a TEnum that is the size of a byte will condense down to just a ReadByte() call with no size/type checks
* Implemented reading and writing for Half, DateOnly, TimeOnly, Vector2, Vector3, Vector4, Quaternion, and Matrix4x4
* Removed bloated overloads (with array offset/count, alternate Encoding/BooleanSize, null termination, etc.). The reader/writer now respects its state (such as whether to use ASCII, and which BooleanSize to use) which you can change at any time
* decimal int order now matches with .net APIs
* Removed EndianBitConverter in favor of EndianBinaryPrimitives, which has similar API while using modern programming like Span&lt;T&gt;
* API uses nullable notations
* You can now ReadObject() and WriteObject() with primitives and other supported types like DateTime, Vector3, etc.
* Removed Encoding usage. The whole thing was very complicated before, and it barely functioned. Now you have ASCII and .net (UTF16-LE) support by default, and can add your own requirements either by extension methods or inheriting the reader/writer</PackageReleaseNotes>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
Expand Down

0 comments on commit 9b04ae5

Please sign in to comment.