Merge branch 'master' of https://github.com/dbolin/Apex.Serialization

dbolin · Jul 7, 2020 · fea50f7 · fea50f7
2 parents 276d85e + 7c233e3
commit fea50f7
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 9 deletions.
diff --git a/Apex.Serialization/Apex.Serialization.csproj b/Apex.Serialization/Apex.Serialization.csproj
@@ -45,7 +45,7 @@
 
   <ItemGroup>
     <PackageReference Include="Mono.Cecil" Version="0.11.2" />
-    <PackageReference Include="System.Collections.Immutable" Version="1.7.0" />
+    <PackageReference Include="System.Collections.Immutable" Version="1.7.1" />
     <PackageReference Include="System.Memory" Version="4.5.4" />
     <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="4.7.1" />
   </ItemGroup>

diff --git a/Benchmark/Benchmark.csproj b/Benchmark/Benchmark.csproj
@@ -17,11 +17,11 @@
     <PackageReference Include="Ceras" Version="4.1.7" />
     <PackageReference Include="Ceras.ImmutableCollections" Version="1.0.0" />
     <PackageReference Include="FluentAssertions" Version="5.10.3" />
-    <PackageReference Include="Hyperion" Version="0.9.15" />
-    <PackageReference Include="MessagePack" Version="2.1.115" />
-    <PackageReference Include="MessagePack.ImmutableCollection" Version="2.1.115" />
+    <PackageReference Include="Hyperion" Version="0.9.16" />
+    <PackageReference Include="MessagePack" Version="2.1.152" />
+    <PackageReference Include="MessagePack.ImmutableCollection" Version="2.1.152" />
     <PackageReference Include="NetSerializer" Version="4.1.1" />
-    <PackageReference Include="protobuf-net" Version="3.0.0-alpha.43" />
+    <PackageReference Include="protobuf-net" Version="3.0.27" />
     <PackageReference Include="ZeroFormatter" Version="1.6.4" />
   </ItemGroup>
 

diff --git a/README.md b/README.md
@@ -11,6 +11,15 @@ Suitable for realtime workloads where the serialized data will not persist for l
 
 [Nuget Package](https://www.nuget.org/packages/Apex.Serialization/)
 
+### Use Cases
+
+#### Good
+- Caching of data that can be reproduced if lost or unable to be deserialized
+- Distributed processing where all workers are using the same runtime/application versions and are hosted on the same type of hardware
+
+#### Bad
+- Any type of long term storage, such as save files or data archiving, since changes to schema, runtime, library versions, etc. could make deserialization no longer possible
+
 ### Limitations
 
 As the serialization is contract-less, the binary format produced depends on precise characteristics of the types serialized. Most changes to types, such as adding or removing fields, renaming types, or changing relationships between types will break compatibility with previously serialized data.  Serializing and deserializing between different chip architectures and .NET runtimes is not supported.

diff --git a/Tests/Apex.Serialization.Tests/Apex.Serialization.Tests.csproj b/Tests/Apex.Serialization.Tests/Apex.Serialization.Tests.csproj
@@ -17,16 +17,16 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="coverlet.msbuild" Version="2.8.1">
+    <PackageReference Include="coverlet.msbuild" Version="2.9.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
     <PackageReference Include="FluentAssertions" Version="5.10.3" />
     <PackageReference Include="Microsoft.CSharp" Version="4.7.0" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.5.0" />
-    <PackageReference Include="System.Collections.Immutable" Version="1.7.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.6.1" />
+    <PackageReference Include="System.Collections.Immutable" Version="1.7.1" />
     <PackageReference Include="xunit" Version="2.4.1" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.1">
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.2">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
     </PackageReference>