Skip to content

Commit 53d24a9

Browse files
committed
Added basic docs
1 parent 435d230 commit 53d24a9

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
11
# SwiftFormatterPlugin
22

3-
A description of this package.
3+
A Swift Package Manager plugin which runs [SwiftFormat](https://github.com/nicklockwood/SwiftFormat).
4+
5+
## Usage
6+
7+
Add this repo to your package dependencies:
8+
9+
```Swift
10+
dependencies: [
11+
.package(url: "https://github.com/elegantchaos/SwiftFormatterPlugin", from: "1.0.2"),
12+
/* other dependencies here... */
13+
],
14+
```
15+
16+
Invoke the tool from the command line:
17+
18+
`swift package plugin --allow-writing-to-package-directory format-source-code`
19+

0 commit comments

Comments
 (0)