Merge pull request #200 from heaven-born/master

Minor doc sync for #197 changes.
zio · Apr 27, 2023 · fbb75d0 · fbb75d0
2 parents f76f4b9 + ae2fbac
commit fbb75d0
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ libraryDependencies += "dev.zio" %% "zio-lambda-response" % "1.0.3"
 
 ## Usage
 
-Create your Lambda function by extending ZLambdaApp
+Create your Lambda function by providing it to `ZLambdaRunner.serve(...)` method.
 
 ```scala
 import zio.Console._
@@ -29,7 +29,7 @@ import zio.lambda._
 
 object SimpleHandler extends ZIOAppDefault {
 
-   def app(request: CustomEvent, context: Context) = for {
+   def app(request: KinesisEvent, context: Context) = for {
       _ <- printLine(event.message)
    } yield "Handler ran successfully"
 

diff --git a/docs/index.md b/docs/index.md
@@ -20,7 +20,7 @@ libraryDependencies += "dev.zio" %% "zio-lambda-response" % "@VERSION@"
 
 ## Usage
 
-Create your Lambda function by extending ZLambdaApp
+Create your Lambda function by providing it to `ZLambdaRunner.serve(...)` method.
 
 ```scala
 import zio.Console._
@@ -29,7 +29,7 @@ import zio.lambda._
 
 object SimpleHandler extends ZIOAppDefault {
 
-   def app(request: CustomEvent, context: Context) = for {
+   def app(request: KinesisEvent, context: Context) = for {
       _ <- printLine(event.message)
    } yield "Handler ran successfully"
 

diff --git a/lambda/src/main/scala/zio/lambda/internal/ZLambdaAppReflective.scala b/lambda/src/main/scala/zio/lambda/internal/ZLambdaAppReflective.scala
@@ -3,7 +3,7 @@ package zio.lambda.internal
 import zio._
 
 /**
- * The main class to use ZLambda as a Layer
+ * The main class to use ZIOAppDefault as a Layer
  *
  * https://docs.aws.amazon.com/lambda/latest/dg/runtimes-custom.html
  * https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html