Skip to content

Commit

Permalink
chore: update README.md (#19)
Browse files Browse the repository at this point in the history
  • Loading branch information
bouassaba authored Nov 24, 2024
1 parent ae4c53d commit da919d4
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
Prerequisites:

- Install [Swift](https://www.swift.org/) via [Xcode](https://developer.apple.com/xcode/) or [Swift Version Manager](https://github.com/kylef/swiftenv), the supported Swift version is 5.10.
- Install [SwiftFormat](https://github.com/nicklockwood/SwiftFormat).
- Install [SwiftLint](https://github.com/realm/SwiftLint).

This is a Swift package, it can be installed using the [Swift Package Manager](https://www.swift.org/documentation/package-manager/) and imported in your code as follows:
Expand All @@ -17,13 +16,17 @@ import VoltaserveCore
Format code:

```shell
swiftformat .
swift format -i -r .
```

Lint code:

```shell
swiftlint .
swift format lint -r .
```

```shell
swiftlint lint --strict .
```

## Tests
Expand Down

0 comments on commit da919d4

Please sign in to comment.