Commit f56be8f4 authored by Ray Koopa's avatar Ray Koopa

Adding deprecation and unlisting information.

parent 44c14756
......@@ -21,21 +21,24 @@ further code required.
The library is available in the following NuGet packages:
Core functionality:
- [Syroot.BinaryData](https://www.nuget.org/packages/Syroot.BinaryData) (unsigned)
- [Syroot.BinaryData.Signed](https://www.nuget.org/packages/Syroot.BinaryData.Signed) (signed assembly)
- [Syroot.BinaryData](https://www.nuget.org/packages/Syroot.BinaryData)
Serialization functionality (adds the core package dependency):
- [Syroot.BinaryData.Serialization](https://www.nuget.org/packages/Syroot.BinaryData.Serialization) (unsigned)
- [Syroot.BinaryData.Serialization.Signed](https://www.nuget.org/packages/Syroot.BinaryData.Serialization.Signed) (signed assembly)
- [Syroot.BinaryData.Serialization](https://www.nuget.org/packages/Syroot.BinaryData.Serialization)
If you want to compile the libraries yourself, Visual Studio 2017 with the 15.7 update is required, as the library uses
the latest C# 7.3 features not available in earlier versions.
### Updated from 4.x.x?
### Deprecating 4.x and signed packages
The previous [Syroot.IO.BinaryData](https://www.nuget.org/packages/Syroot.IO.BinaryData) package has been split into the
core and the serialization packages mentioned above. Beyond many new features, several breaking changes were made.
Please have a look at the most recent [release notes](https://gitlab.com/Syroot/BinaryData/tags) for more info.
The previous `Syroot.IO.BinaryData` package has been split into the core and the serialization packages mentioned
above and is now deprecated. The old packges will be unlisted in May 2019.
Beyond many new features, several breaking changes were made. Please have a look at the most recent
[release notes](https://gitlab.com/Syroot/BinaryData/tags) for more info.
Signed packages have also been unlisted as this legacy scenario is no longer supported by new versions.
Any unlisted packages can still be installed if referenced directly in a project.
## Documentation
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment