Skip to content
Michael Brown edited this page Nov 30, 2018 · 1 revision

Welcome to AnyDiff

Welcome to the official AnyDiff documentation wiki! In here, you will find a few snippets and further information about AnyDiff. You may want to read the introductory README before continuing for basic usage examples.

Installation

Install AnyDiff nuget package from the Package Manager Console:

PM> Install-Package AnyDiff

Compatibility

AnyDiff is compatible with .Net Standard 2.0+ and .Net Framework 4.0+

The only dependencies AnyDiff has is for Newtonsoft.Json and that's purely for attributes. We may look at removing that dependency to keep the library lean.

Performance

AnyDiff has not yet been optimized for performance and that is planned shortly. The core ideology behind AnyDiff was to support a wide range of serialization challenges rather than being super fast. It's a tool to solve problems.

Getting Started

Getting started with AnyDiff is very simple:

using AnyDiff;

var object1 = new MyComplexObject(1, "A string");
var object2 = new MyComplexObject(1, "A string");
var diff = AnyDiff.Diff(object1, object2);
Assert.AreEqual(diff.Count, 0);

Tracking Issues

I'm very interested in expanding unsupported scenarios. If you find that AnyDiff isn't working for you please file a new issue and I'll work towards adding support for it immediately. To be of most assistance please include a class example that I can use to reproduce the issue.