From 00109f3eb0a40cf541cd116d0359da119248cc4a Mon Sep 17 00:00:00 2001 From: Austin Treat Emmons Date: Wed, 20 Mar 2024 16:07:06 -0400 Subject: [PATCH] Cleanup in README for broken links (#190) Adds example of running swiftlint from CLI --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1a8c98dd..c3037527 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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.