Fix Readme and rename Demo App

Author: Andrea Scuderi

Package.swift

@@ -3,7 +3,7 @@
 import PackageDescription
 
 #if os(macOS)
-let platforms: [PackageDescription.SupportedPlatform]? = [.macOS(.v15), .iOS(.v13)]
+let platforms: [PackageDescription.SupportedPlatform]? = [.macOS(.v15)]
 #else
 let platforms: [PackageDescription.SupportedPlatform]? = nil
 #endif
@@ -21,8 +21,8 @@ let package = Package(
             targets: ["BreezeLambdaAPI"]
         ),
         .executable(
-            name: "BreezeDemoApplication",
-            targets: ["BreezeDemoApplication"]
+            name: "BreezeLambdaItemAPI",
+            targets: ["BreezeLambdaItemAPI"]
         )
     ],
     dependencies: [
@@ -35,7 +35,7 @@ let package = Package(
     ],
     targets: [
         .executableTarget(
-            name: "BreezeDemoApplication",
+            name: "BreezeLambdaItemAPI",
             dependencies: [
                 "BreezeLambdaAPI"
             ]

README.md

@@ -69,7 +69,16 @@ extension Item: BreezeCodable { }
 Add the implementation of the Lambda to the file `swift.main`
 
 ```swift
-BreezeLambdaAPI<Item>.main()
+@main
+struct BreezeLambdaItemAPI {
+    static func main() async throws {
+      do {
+            try await BreezeLambdaAPI<Item>().run()
+        } catch {
+            print(error.localizedDescription)
+        }
+    }
+}
 ```
 
 ## Documentation

Sources/BreezeDemoApplication/BreezeDemoApplication.swift renamed to Sources/BreezeLambdaItemAPI/BreezeLambdaItemAPI.swift

@@ -15,6 +15,11 @@
 import BreezeLambdaAPI
 import BreezeDynamoDBService
 
+/// The BreezeLambdaItemAPI is an example of a Breeze Lambda API that interacts with DynamoDB to manage items.
+/// Use this example to understand how to create a Breeze Lambda API that can list, create, update, and delete items in a DynamoDB table.
+
+/// The Item struct represents an item in the DynamoDB table.
+/// It conforms to Codable for easy encoding and decoding to/from JSON.
 struct Item: Codable {
     public var key: String
     public let name: String
@@ -31,27 +36,48 @@ struct Item: Codable {
     }
 }
 
+/// BreezeCodable is a protocol that allows the Item struct to be used with Breeze Lambda API.
 extension Item: BreezeCodable { }
 
+/// APIConfiguration is a struct that conforms to APIConfiguring.
+/// It provides the configuration for the Breeze Lambda API, including the DynamoDB table name, key name, and endpoint.
+/// It also specifies the operation to be performed, which in this case is listing items.
 struct APIConfiguration: APIConfiguring {
     let dbTimeout: Int64 = 30
     func operation() throws -> BreezeOperation {
         .list
     }
 
+    /// Get the configuration for the DynamoDB service.
+    /// It specifies the region, table name, key name, and endpoint.
+    /// In this example, it uses a local Localstack endpoint for testing purposes.
+    /// You can change the region, table name, key name, and endpoint as needed for your application.
+    /// Remove the endpoint for production use.
     func getConfig() throws -> BreezeDynamoDBConfig {
         BreezeDynamoDBConfig(region: .useast1, tableName: "Breeze", keyName: "itemKey", endpoint: "http://127.0.0.1:4566")
     }
 }
 
 @main
-struct BreezeDemoApplication {
+struct BreezeLambdaItemAPI {
     static func main() async throws {
+#if DEBUG
         do {
             let lambdaAPIService = try await BreezeLambdaAPI<Item>(apiConfig: APIConfiguration())
             try await lambdaAPIService.run()
         } catch {
             print(error.localizedDescription)
         }
+#else
+        // In production, you can run the BreezeLambdaAPI without the API configuration.
+        // This will use the default configuration for the BreezeDynamoDBService.
+        // Make sure to set the environment variables for the DynamoDB service:
+        // DYNAMODB_TABLE_NAME, DYNAMODB_KEY_NAME, and AWS_REGION.
+        do {
+            try await BreezeLambdaAPI<Item>().run()
+        } catch {
+            print(error.localizedDescription)
+        }
+#endif
     }
 }