From 74b5e58aae7ce3c36a37771cd7ab976f90f3b1d6 Mon Sep 17 00:00:00 2001 From: Mahmood Tahir Date: Mon, 3 Oct 2022 16:48:25 -0400 Subject: [PATCH] Update README.md --- README.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 066829a..05e77c4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,32 @@ # swift-snapshot-testing-dump -A plugin for `swift-snapshot-testing` that combines it with `swift-custom-dump` to be able to produce textual snapshots of model objects. +A plugin for [swift-snapshot-testing](https://github.com/pointfreeco/swift-snapshot-testing) that combines it with [swift-custom-dump](https://github.com/pointfreeco/swift-custom-dump/) to be able to produce textual snapshots of model objects. + +### Usage + +Swift Package Manager + +If you want to use SnapshotTesting in any other project that uses SwiftPM, add the package as a dependency in Package.swift: + +``` +dependencies: [ + .package( + url: "https://github.com/tahirmt/swift-snapshot-testing-dump", + from: "1.0.0" + ), +] +``` +Next, add `SnapshotTestingDump` as a dependency of your test target: + +``` +targets: [ + .target(name: "MyApp"), + .testTarget( + name: "MyAppTests", + dependencies: [ + "MyApp", + .product(name: "SnapshotTestingDump", package: "swift-snapshot-testing-dump"), + ] + ) +] +```