Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
taji-taji committed Aug 28, 2022
1 parent 32c7f76 commit 414aa20
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,28 @@ This plugin will comment unreferenced code detected by periphery via Danger Swif

### Package.swift

1. Add DangerSwiftPeriphery to your `Package.swift` dependencies:

```swift
.package(url: "https://github.com/taji-taji/DangerSwiftPeriphery.git", from: "1.0.0")
```

2. Add DangerSwiftPeriphery to your dependencies of `DangerDependencies` target:

```swift
.product(name: "DangerSwiftPeriphery", package: "DangerSwiftPeriphery")
```

The following is an example of `Package.swift` in its entirety.

```swift
let package = Package(
// ...
dependencies: [
// Danger
.package(url: "https://github.com/danger/swift.git", from: "3.0.0"), // dev
// Danger Plugins
// Add the line below.
// 1. Add DangerSwiftPeriphery to your `Package.swift` dependencies:
.package(url: "https://github.com/taji-taji/DangerSwiftPeriphery.git", from: "1.0.0"), // dev
],
targets: [
Expand All @@ -41,7 +55,8 @@ let package = Package(
.target(name: "DangerDependencies",
dependencies: [
.product(name: "Danger", package: "swift"),
"DangerSwiftPeriphery",
// 2. Add DangerSwiftPeriphery to your dependencies of `DangerDependencies` target:
.product(name: "DangerSwiftPeriphery", package: "DangerSwiftPeriphery"),
]),
// ...
]
Expand Down

0 comments on commit 414aa20

Please sign in to comment.