further

CONTRIBUTING.md

@@ -56,3 +56,5 @@ this is a SwiftUI app and I want to use all the new Observable macros etc, so th
 TODO document how to run example app on device
 
 TODO explain that all features should be demonstrable in the example app
+
+TODO explain the SwiftLint rule for generated comment headings

Example/AblyChatExample.xcodeproj/project.pbxproj

@@ -7,6 +7,7 @@
 	objects = {
 
 /* Begin PBXBuildFile section */
+		21971DFF2C60D89C0074B8AE /* AblyChat in Frameworks */ = {isa = PBXBuildFile; productRef = 21971DFE2C60D89C0074B8AE /* AblyChat */; };
 		21F09AA02C60CAF00025AF73 /* AblyChatExampleApp.swift in Sources */ = {isa = PBXBuildFile; fileRef = 21F09A9F2C60CAF00025AF73 /* AblyChatExampleApp.swift */; };
 		21F09AA22C60CAF00025AF73 /* ContentView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 21F09AA12C60CAF00025AF73 /* ContentView.swift */; };
 		21F09AA42C60CAF20025AF73 /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 21F09AA32C60CAF20025AF73 /* Assets.xcassets */; };
@@ -27,17 +28,26 @@
 			isa = PBXFrameworksBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				21971DFF2C60D89C0074B8AE /* AblyChat in Frameworks */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
 /* End PBXFrameworksBuildPhase section */
 
 /* Begin PBXGroup section */
+		21971DFD2C60D89C0074B8AE /* Frameworks */ = {
+			isa = PBXGroup;
+			children = (
+			);
+			name = Frameworks;
+			sourceTree = "<group>";
+		};
 		21F09A932C60CAF00025AF73 = {
 			isa = PBXGroup;
 			children = (
 				21F09A9E2C60CAF00025AF73 /* AblyChatExample */,
 				21F09A9D2C60CAF00025AF73 /* Products */,
+				21971DFD2C60D89C0074B8AE /* Frameworks */,
 			);
 			sourceTree = "<group>";
 		};
@@ -85,6 +95,9 @@
 			dependencies = (
 			);
 			name = AblyChatExample;
+			packageProductDependencies = (
+				21971DFE2C60D89C0074B8AE /* AblyChat */,
+			);
 			productName = AblyChatExample;
 			productReference = 21F09A9C2C60CAF00025AF73 /* AblyChatExample.app */;
 			productType = "com.apple.product-type.application";
@@ -361,6 +374,13 @@
 			defaultConfigurationName = Release;
 		};
 /* End XCConfigurationList section */
+
+/* Begin XCSwiftPackageProductDependency section */
+		21971DFE2C60D89C0074B8AE /* AblyChat */ = {
+			isa = XCSwiftPackageProductDependency;
+			productName = AblyChat;
+		};
+/* End XCSwiftPackageProductDependency section */
 	};
 	rootObject = 21F09A942C60CAF00025AF73 /* Project object */;
 }

Example/AblyChatExample/AblyChatExampleApp.swift

@@ -1,10 +1,4 @@
-//
-//  AblyChatExampleApp.swift
-//  AblyChatExample
-//
-//  Created by Lawrence Forooghian on 05/08/2024.
-//
-
+import AblyChat
 import SwiftUI
 
 @main

Example/AblyChatExample/ContentView.swift

@@ -1,13 +1,10 @@
-//
-//  ContentView.swift
-//  AblyChatExample
-//
-//  Created by Lawrence Forooghian on 05/08/2024.
-//
-
+import AblyChat
 import SwiftUI
 
 struct ContentView: View {
+    /// Just used to check that we can successfully import and use the AblyChat library. TODO remove this once we start building the library
+    @State private var ablyChatClient = AblyChatClient()
+
     var body: some View {
         VStack {
             Image(systemName: "globe")

Sources/AblyChat/AblyChat.swift

@@ -1 +1,7 @@
 import Ably
+
+/// Temporary class just used to check that the example app and tests can use the library. TODO remove this once we start building the library
+public class AblyChatClient {
+    /// Initializes an instance of `AblyChatClient`.
+    public init() {}
+}

Tests/AblyChatTests/AblyChatTests.swift

@@ -4,10 +4,6 @@ import XCTest
 final class AblyChatTests: XCTestCase {
     // swiftlint:disable:next empty_xctest_method
     func testExample() throws {
-        // XCTest Documentation
-        // https://developer.apple.com/documentation/xctest
-
-        // Defining Test Cases and Test Methods
-        // https://developer.apple.com/documentation/xctest/defining_test_cases_and_test_methods
+        XCTAssertNoThrow(AblyChatClient())
     }
 }