Skip to content

Commit c924f23

Browse files
committed
2 parents ee0b2fd + fea38a7 commit c924f23

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
# ByteStream
2-
A blazing fast byte (de)serializer for C#
2+
A blazing fast byte (de)serializer for C#.
3+
4+
Available on Nuget via ```Install-Package ByteStream```
35

46
## What is ByteStream?
57
Bytestream is a small library that enables blazing fast serialization of a collection of types to raw bytes. Either in the form of a byte array `byte[]` or unmanaged memory `IntPtr`.
68
The library performs no memory allocation on its own, so you are free to use your own memory allocator!
79

10+
ByteStream is written in NetStandard2.0 making it compatible with .Net, .Net Core and Unity3D among things!
11+
812
*__Carefully read the Usage section__ for a brief introduction on how to use the library.*
913

1014
## What does ByteStream offer?
@@ -19,7 +23,7 @@ Bytestream offers 2 sets of serializers and deserializers, called writers and re
1923
- Prefixes strings and memory blocks with a 2-byte length (optional).
2024

2125
## Supported types:
22-
- All types that adhere to the [managed constraint](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/unmanaged-types) can be written to, and read from the buffers.
26+
- All types that adhere to the [unmanaged constraint](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/unmanaged-types) can be written to, and read from the buffers.
2327
- Byte arrays
2428
- ANSI strings (1-byte per character)
2529
- UTF16 strings (2-byte per character, default in C#)
@@ -28,7 +32,7 @@ Bytestream offers 2 sets of serializers and deserializers, called writers and re
2832

2933
## Drawbacks
3034
- The ByteWriter and ByteReader makes heavy use of memory pinning. This can make the unmanaged variant preferable when possible.
31-
- The writers and readers always make use of pointer conversion. In the case of writing single-byte values to a byte[] buffer, consider directly writing these values to the buffer instead.
35+
- The writers and readers always make use of pointer conversion. In the case of writing single-byte values to a `byte[]` buffer, consider directly writing these values to the buffer instead.
3236

3337
# Technical specifications:
3438

0 commit comments

Comments
 (0)