Skip to content

Commit

Permalink
Cleanup in README for broken links (#190)
Browse files Browse the repository at this point in the history
Adds example of running swiftlint from CLI
  • Loading branch information
atreat authored Mar 20, 2024
1 parent 22d063c commit 00109f3
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,10 +133,6 @@ Embrace.client?.metadata.userIdentifier = "827B02FE-D868-461D-8B4A-FE7371818369"
Embrace.client?.metadata.userName = "tony.the.tester"
````

## Documentation

[API Reference Docs](https://embrace-io.github.io/embrace-apple-sdk/documentation/EmbraceIO).

## Prerequisites

### Github
Expand Down Expand Up @@ -164,11 +160,14 @@ bin/test | xcpretty

## Linting and Guidelines

All source files must follow our guidelines described [here](https://www.notion.so/embraceio/iOS-Developer-Guidelines-078360496fff4379b033e67c377d42e7).

We use [SwiftLint](https://github.com/realm/SwiftLint) to enforce them and every pull request must satisfy them to be merged.
SwiftLint is used as a plugin in all of our targets to get warnings and errors directly in Xcode.

You can run the swiftlint plugin from the CLI as well:
```sh
swift run swiftlint --fix
```

### Using SwiftLint

Aside from the warnings and errors that will appear directly in Xcode, you can use SwiftLint to automatically correct some issues.
Expand Down

0 comments on commit 00109f3

Please sign in to comment.