Quickstart docs

Author: jatcwang

README.md

@@ -16,7 +16,12 @@
 
 Hungry for some good diffs? Check out the [documentation](https://jatcwang.github.io/difflicious/)!
 
-# Attributions & Inspirations
+# Contributing 
+
+All contributions are welcome including suggestions and ideas. For larger changes please raise an issue
+first to avoid duplicate work :) 
+
+# Attributions
 
 This project takes many inspirations from 
 

docs/docs/docs/TestFrameworkIntegrations.md docs/docs/docs/LibraryIntegrations.md

@@ -1,10 +1,10 @@
 ---
 layout: docs
-title:  "Test Framework Integrations"
-permalink: docs/test-framework-integrations
+title:  "Library Integrations"
+permalink: docs/library-integrations
 ---
 
-# Test Framework Integrations
+# Library Integrations
 
 ## MUnit
 
@@ -47,3 +47,22 @@ class MyTest extends AnyFunSuite {
   }
 }
 ```
+
+## Cats
+
+Differ instances for cats data structures like `NonEmptyList` and `Chain` can be found in
+
+```
+"com.github.jatcwang" %% "difflicious-scalatest" % "{{ site.version }}" % Test
+```
+
+```scala mdoc:nest
+import difflicious.Differ
+import difflicious.cats.implicits._
+import cats.data.{NonEmptyMap, NonEmptyList}
+
+val differ: Differ[List[NonEmptyMap[String, NonEmptyList[Int]]]] = Differ[List[NonEmptyMap[String, NonEmptyList[Int]]]]
+```
+
+
+

docs/docs/docs/QuickStart.md

@@ -0,0 +1,64 @@
+---
+layout: docs
+title:  "Quickstart"
+permalink: docs/quickstart
+---
+
+# Quickstart
+
+Let's see how you can use Difflicious in your MUnit tests
+
+First, add the following dependency in your SBT configuration:
+
+```
+"com.github.jatcwang" %% "difflicious-munit" % "{{ site.version }}" % Test
+```
+
+If you are running tests using **IntelliJ IDEA**'s test runner, you will want 
+to turn off the red text coloring it uses for test failure outputs because
+it interferes with difflicious' color outputs.
+
+In <b>File | Settings | Editor | Color Scheme | Console Colors | Console | Error Output</b>, uncheck the red foreground color.
+
+Let's say you have some case classes..
+
+```scala mdoc:silent
+case class Person(
+  name: String,
+  age: Int,
+  occupation: String
+)
+```
+
+To perform diffs with Difflicious, you will need to derive some `Differs`
+
+```scala mdoc:silent
+import munit.FunSuite
+import difflicious.Differ
+import difflicious.munit.MUnitDiff._
+
+class ExampleTest extends FunSuite {
+
+  // Derive Differs for case class and sealed traits 
+  implicit val personDiffer: Differ[Person] = Differ.derive[Person]
+
+  test("two list of people should be the same") {
+    Differ[List[Person]].assertNoDiff(
+      List(
+        Person("Alice", 50, "Doctor")
+      ),
+      List(
+        Person("Alice", 40, "Doctor"),
+        Person("Bob", 30, "Teacher")
+      )
+    )
+  }
+}
+```
+
+Run the tests, and you should see a nice failure diff:
+
+<img src="../img/diff_failure.jpg" />
+
+Pretty right? You should explore the next sections of the documentation and learn about the different Differs 
+and how you can configure them!

docs/src/main/resources/microsite/data/menu.yml

@@ -1,12 +1,14 @@
 options:
   - title: Introduction
     url: docs/introduction
+  - title: Quickstart
+    url: docs/quickstart
   - title: Types of Differs
     url: docs/types-of-differs
   - title: Configuring Differs
     url: docs/configuring-differs
-  - title: Test Framework Integrations
-    url: docs/test-framework-integrations
+  - title: Library Integrations
+    url: docs/library-integrations
   - title: Best Practices / FAQ
     url: docs/best-practices-and-faq
   - title: Cheatsheet

docs/src/main/resources/microsite/img/diff_failure.jpg

@@ -0,0 +1,3 @@
+package difflicious.cats
+
+object implicits extends CatsInstances

modules/cats/src/main/scala/difflicious/cats/implicits.scala

@@ -1,11 +1,13 @@
+package difflicious.cats
+
 import munit.FunSuite
-import difflicious.cats.CatsInstances._
 import cats.data._
 import cats.laws.discipline.arbitrary._
 import difflicious.Differ
 import difflicious.testtypes.{CC, MapKey}
 import difflicious.testutils._
 import difflicious.implicits._
+import difflicious.cats.implicits._
 
 class CatsDataDiffSpec extends FunSuite {
   test("NonEmptyMap: Has map-like diff result") {