Skip to content

Commit a8a3d5e

Browse files
committed
docs: update formatting section in readme
1 parent 8dc3cc2 commit a8a3d5e

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@
22

33
## Contributing
44
### Code Formatting
5-
This package makes use of [swift-format](https://github.com/swiftlang/swift-format), which is built directly into the swift toolchain as of
6-
swift 6. To apply formatting rules to all files, which you should do before submitting a PR, run from the root of the repository:
5+
This package makes use of [SwiftFormat](https://github.com/nicklockwood/SwiftFormat?tab=readme-ov-file#command-line-tool), which you can install
6+
from [homebrew](https://brew.sh/).
7+
8+
To apply formatting rules to all files, which you should do before submitting a PR, run from the root of the repository:
79

810
```sh
9-
swift format --in-place --recursive .
11+
swiftformat .
1012
```
11-
1213
Formatting is validated with the `--strict` flag on every PR
1314

0 commit comments

Comments
 (0)