Readme

README.md

@@ -1 +1,42 @@
 # diff-x
+
+Pretty diffs for case classes. 
+
+## Scalatest integration
+
+To use with scalatest, add the following dependency:
+
+```scala
+"com.softwaremill.diffx" %% "diffx-scalatest" % "0.1.0"
+```
+
+Then, extend the `com.softwaremill.diffx.DiffMatcher` trait or `import com.softwaremill.diffx.DiffMatcher._`.
+You will then be able to use syntax such as:
+
+```scala
+left should matchTo(right)
+```
+
+Giving you nice error messages, such as:
+
+![alt text](https://raw.githubusercontent.com/softwaremill/diffx/master/example.png)
+
+## Using directly
+
+Add the following dependency:
+
+```scala
+"com.softwaremill.diffx" %% "diffx-core" % "0.1.0"
+```
+
+Then call:
+
+```scala
+import com.softwaremill.diffx.DiffFor
+implicitly[DiffFor[T]].diff(o1, o2)
+```
+
+## Custom types
+
+If you'd like to implement custom matching logic for a custom type, create an implicit `DiffFor` instance for that 
+type, and make sure it's in scope when creating `DiffFor` for the case class.

core/src/main/scala/com/softwaremill/diffx/DiffFor.scala

@@ -1,7 +1,6 @@
 package com.softwaremill.diffx
 
 trait DiffFor[T] {
-
   def diff(left: T, right: T): DiffResult
 }
 

core/src/test/scala/com/softwaremill/diffx/DiffTest.scala

@@ -18,7 +18,8 @@ class DiffTest extends FlatSpec with Matchers with DiffForInstances {
   it should "calculate diff for product types" in {
     compare(p1, p2) shouldBe DiffResultObject(
       "Person",
-      Map("name" -> Identical("kasper"), "age" -> DiffResultValue(22, 11), "in" -> Identical(instant)))
+      Map("name" -> Identical("kasper"), "age" -> DiffResultValue(22, 11), "in" -> Identical(instant))
+    )
   }
 
   it should "calculate identity for product types" in {
@@ -32,10 +33,10 @@ class DiffTest extends FlatSpec with Matchers with DiffForInstances {
       "Family",
       Map(
         "first" -> Identical(p1),
-        "second" -> DiffResultObject("Person",
-                                     Map("name" -> Identical("kasper"),
-                                         "age" -> DiffResultValue(11, 22),
-                                         "in" -> Identical(instant)))
+        "second" -> DiffResultObject(
+          "Person",
+          Map("name" -> Identical("kasper"), "age" -> DiffResultValue(11, 22), "in" -> Identical(instant))
+        )
       )
     )
   }
@@ -50,20 +51,22 @@ class DiffTest extends FlatSpec with Matchers with DiffForInstances {
           "List",
           Map(
             "0" -> Identical(p1),
-            "1" -> DiffResultObject("Person",
-                                    Map("name" -> Identical("kasper"),
-                                        "age" -> DiffResultValue(11, 22),
-                                        "in" -> Identical(instant))),
+            "1" -> DiffResultObject(
+              "Person",
+              Map("name" -> Identical("kasper"), "age" -> DiffResultValue(11, 22), "in" -> Identical(instant))
+            ),
             "2" -> DiffResultMissing(Person("kasper", 22, instant))
           )
-        ))
+        )
+      )
     )
   }
 
   it should "calculate diff for sealed trait objects" in {
     compare[TsDirection](TsDirection.Outgoing, TsDirection.Incoming) shouldBe DiffResultValue(
       "com.softwaremill.diffx.TsDirection.Outgoing",
-      "com.softwaremill.diffx.TsDirection.Incoming")
+      "com.softwaremill.diffx.TsDirection.Incoming"
+    )
   }
 
   val right: Foo = Foo(

scalatest/src/main/scala/com/softwaremill/diffx/scalatest/DiffMatcher.scala

@@ -16,3 +16,5 @@ trait DiffMatcher extends DiffForInstances {
   }
 
 }
+
+object DiffMatcher extends DiffMatcher

scalatest/src/test/scala/com/softwaremill/diffx/scalatest/DiffMatcherTest.scala

@@ -15,7 +15,7 @@ class DiffMatcherTest extends FlatSpec with Matchers with DiffMatcher {
     Some(right)
   )
 
-  ignore should "wor" in {
+  ignore should "work" in {
     left should matchTo(right)
   }