Skip to content

Commit b8431a2

Browse files
committed
Stress the difference between both consumption methods
1 parent a1ca415 commit b8431a2

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ refer to the main repository, especially [Installation](https://github.com/realm
1010
> developed there next to SwiftLint as a command-line tool itself. The plugin source code is kept in sync with SwiftLint
1111
> and so are the releases. Please report issues and propose changes to the plugins in the main source repository.
1212
13-
Offering the plugins in a separate package has multiple advantages:
13+
Offering the plugins in a separate package has multiple advantages you should be aware of:
1414

1515
* No need to clone the whole SwiftLint repository.
1616
* SwiftLint itself is included as a binary dependency, thus the consumer doesn't need to build it first.
@@ -19,3 +19,9 @@ Offering the plugins in a separate package has multiple advantages:
1919
a lot of build time alone.
2020
* For projects having adopted Swift macros or depend on SwiftSyntax for other reasons, there is no version conflict
2121
caused by the fact that SwiftLint has to rely on a fixed and pretty current version.
22+
* As this Swift package doesn't provide any build products, there is no way to add them as dependencies to iOS,
23+
watchOS, ... targets. They would fail to build if you were to do that.
24+
25+
That said, you are perfectly free to consume the plugins directly from the
26+
[SwiftLint](https://github.com/realm/swiftlint) repository instead if you like to. Both ways are functionally
27+
equivalent, however one comes with the aforementioned drawbacks.

0 commit comments

Comments
 (0)