update readme #75
update readme #75
Conversation
motivation: better and more up-to-date information changes: rewrite readme to reflect APIs and architecture
Co-authored-by: Konrad `ktoso` Malawski <[email protected]>
Co-authored-by: Fabian Fett <[email protected]>
|
|
||
| 3. Deploy to AWS Lambda. To do so, you need to compile your Application for Amazon Linux 2, package it as a Zip file, and upload to AWS. Swift.org publishes [Swift toolchains and Docker images for Amazon Linux 2](https://swift.org/download/). | ||
|
|
||
| You can find complete sample build and deployment scripts in the [Examples Directory](/Examples) |
There was a problem hiding this comment.
@tomerd If you want me to I could edit my current explanation for our new lambda. Then we have a manual walk-trough as well.
|
@fabianfett okay to merge? |
|
|
||
| 6. In case of error, the library posts to AWS Lambda Runtime Engine `/error` endpoint to provide the error details, which will show up on AWS Lambda logs. | ||
| ### AWS Lambda Runtime Engine Integration |
There was a problem hiding this comment.
Do we want this in the README? IMHO this is more or less a technical detail for developers who want to get involved. Maybe we want to add this to a /docs/Contributing.md?
There was a problem hiding this comment.
I'd keep it here, we do similar things in other projects as README is both for users and potential contributors
|
|
||
| 2. The library parses the response HTTP headers and populate the `Lambda.Context` object. | ||
| ### Configuration |
There was a problem hiding this comment.
I'm not sure if this belongs to Architecture or if it should be its own level 2 heading?
There was a problem hiding this comment.
I think its fine, its at at the same level as other key entities like ByteBufferLambdaHandler etc
Co-authored-by: Fabian Fett <[email protected]>
motivation: better and more up-to-date information
changes: rewrite readme to reflect APIs and architecture