Skip to content
This repository was archived by the owner on Feb 3, 2025. It is now read-only.

Commit 74b5e58

Browse files
authored
Update README.md
1 parent 55ee61a commit 74b5e58

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,32 @@
11
# swift-snapshot-testing-dump
22

3-
A plugin for `swift-snapshot-testing` that combines it with `swift-custom-dump` to be able to produce textual snapshots of model objects.
3+
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.
4+
5+
### Usage
6+
7+
Swift Package Manager
8+
9+
If you want to use SnapshotTesting in any other project that uses SwiftPM, add the package as a dependency in Package.swift:
10+
11+
```
12+
dependencies: [
13+
.package(
14+
url: "https://github.com/tahirmt/swift-snapshot-testing-dump",
15+
from: "1.0.0"
16+
),
17+
]
18+
```
19+
Next, add `SnapshotTestingDump` as a dependency of your test target:
20+
21+
```
22+
targets: [
23+
.target(name: "MyApp"),
24+
.testTarget(
25+
name: "MyAppTests",
26+
dependencies: [
27+
"MyApp",
28+
.product(name: "SnapshotTestingDump", package: "swift-snapshot-testing-dump"),
29+
]
30+
)
31+
]
32+
```

0 commit comments

Comments
 (0)