Update the README #88
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Daniel Spiewak <djspiewak@gmail.com>
kubukoz
approved these changes
Dec 14, 2021
README.md
Outdated
|
|
||
| `IOLambda[Event, Result]` or `IOLambda.Simple[Event, Result]` are the entrypoint for your Lambda (comparable to `IOApp` in Cats Effect). `Event` and `Result` can be any type for which a circe `Decoder` and `Encoder` are defined and must correspond to the "trigger" event and (optional) result for your Lambda. The `feral.lambda.events` package provides some of these models already ([please consider contributing!](https://github.com/typelevel/feral/issues/48)). | ||
|
|
||
| The [examples](https://github.com/typelevel/feral/tree/main/examples/src/main/scala/feral/examples) provide an in-depth demonstration of how to implement your Lambda. |
There was a problem hiding this comment.
Not really in-depth at this moment :)
There was a problem hiding this comment.
Haha, good point. I'm planning to take a pass through and flesh them out a bit, but even after that I suspect this will be an exaggeration :P
ChristopherDavenport
approved these changes
Dec 14, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Any and all feedback appreciated!