Added readme, platform specifications and changed name to MatrixRustSDK

Author: stefanceriu

Package.swift

@@ -8,11 +8,15 @@ let version = "v1.0.0-alpha"
 let url = "https://github.com/matrix-org/matrix-rust-components-swift/releases/download/\(version)/MatrixSDKFFI.xcframework.zip"
 
 let package = Package(
-    name: "MatrixRustComponentsSwift",
+    name: "MatrixRustSDK",
+    platforms: [
+        .iOS(.v15),
+        .macOS(.v12)
+    ],
     products: [
         .library(
-            name: "MatrixRustComponentsSwift",
-            targets: ["MatrixRustComponentsSwift"]),
+            name: "MatrixRustSDK",
+            targets: ["MatrixRustSDK"]),
     ],
     targets: [
         .binaryTarget(
@@ -32,10 +36,10 @@ let package = Package(
             path: "MatrixSDKFFIWrapper"
         ),
         .target(
-            name: "MatrixRustComponentsSwift",
+            name: "MatrixRustSDK",
             dependencies: ["MatrixSDKFFIWrapper"]),
         .testTarget(
-            name: "MatrixRustComponentsSwiftTests",
-            dependencies: ["MatrixRustComponentsSwift"]),
+            name: "MatrixRustSDKTests",
+            dependencies: ["MatrixRustSDK"]),
     ]
 )

README.md

@@ -1,3 +1,17 @@
-# MatrixRustComponentsSwift
+# Swift package for Matrix Rust components
 
-A description of this package.
+This repository is a Swift Package for distributing releases of the [Matrix Rust SDK](https://github.com/matrix-org/matrix-rust-sdk). It provides the Swift source code packaged in a format understood by the Swift package manager, and depends on a pre-compiled binary release of the underlying Rust code published from [Matrix Rust SDK](https://github.com/matrix-org/matrix-rust-sdk).
+
+## Releasing
+
+Whenever a new release of the underlying components is availble, we need to tag a new release in this repo to make them available to Swift components. 
+To do so we need to:
+* running the `.xcframework` build script from `matrix-rust-sdk/apple`
+* copy the generated `.swift` files to this repository under `Sources/MatrixRustComponentsSwift`
+* create a new tag and upload the zipped version of the `.xcframework` to it's artifacts section
+* update the tag version inside `Package.swift`
+
+## Testing locally
+
+The package can be added to an Xcode project from a local checkout and the binary target can be configured with a local `path`. 
+It might be necessary to manually add the resulting library to your project's `General/Frameworks, Libraries, and Embedded Content` for it to work.

Sources/MatrixRustComponentsSwift/ClientError+Error.swift renamed to Sources/MatrixRustSDK/ClientError+Error.swift

@@ -1,5 +1,5 @@
 import XCTest
-@testable import MatrixRustComponentsSwift
+@testable import MatrixRustSDK
 
 final class MatrixRustComponentsSwiftTests: XCTestCase {
     func testExample() throws {