diff --git a/README.md b/README.md index 043b231..e0af85d 100644 --- a/README.md +++ b/README.md @@ -3,19 +3,20 @@ To import packages in AWS Lambda Functions, they are required as Lambda Layers These layers need to match the language runtime/version, architecture, lambda operating system, etc. Creating these in local environments can cause unforeseen inconsistencies and potential compatibility issues -  -# Solution +### Solution This repo tries to solve the problem by standardising the environment using a container. The packages are baked into layers inside this standard container. A .zip artifact is generated, which can be easily uploaded to Lambda Layers +  # Usage 1. Update `requirements.txt` with the packages you want in the layer -[Syntax options for requirements.txt](https://pip.pypa.io/en/stable/reference/requirements-file-format/) +[Syntax options for requirements.txt](https://pip.pypa.io/en/stable/reference/requirements-file-format/) 2. Make sure podman or docker daemon is running 3. Execute `runner.sh` script and it will generate the `python_layer.zip` artifact 4. Upload `python_layer.zip` to Lambda Layers and use it in your Python Lambda function(s) - +> [!NOTE] +> Stating package versions explicitly lowers dependencies, layer size and attack surface ### Following is done automatically by `runner.sh`