Skip to content

Commit

Permalink
docs: corrected bullet point's content spacing/indentation (#81)
Browse files Browse the repository at this point in the history
The content for some bullet points are not correctly indented or spaced.
This causes text and code blocks to not be displayed properly, causing confusion for customers.

This change indents the content of the bullet points so it is now correctly displayed increasing readability.
  • Loading branch information
Callum Bodels authored Jan 5, 2023
1 parent ee52c16 commit 6c827ea
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,10 @@ You can build RIE into a base image. Download the RIE from GitHub to your local

1. Create a script and save it in your project directory. Set execution permissions for the script file.

The script checks for the presence of the `AWS_LAMBDA_RUNTIME_API` environment variable, which indicates the presence of the runtime API. If the runtime API is present, the script runs [the runtime interface client](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-images.html#runtimes-api-client). Otherwise, the script runs the runtime interface emulator.
The script checks for the presence of the `AWS_LAMBDA_RUNTIME_API` environment variable, which indicates the presence of the runtime API. If the runtime API is present, the script runs [the runtime interface client](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-images.html#runtimes-api-client). Otherwise, the script runs the runtime interface emulator.

The following example shows a typical script for a Node.js function.

The following example shows a typical script for a Node.js function.
```
#!/bin/sh
if [ -z "${AWS_LAMBDA_RUNTIME_API}" ]; then
Expand All @@ -91,24 +92,28 @@ The following example shows a typical script for a Node.js function.
3. Install the emulator package and change `ENTRYPOINT` to run the new script by adding the following lines to your Dockerfile:
To use the default x86\_64 architecture
To use the default x86\_64 architecture
```
ADD aws-lambda-rie /usr/local/bin/aws-lambda-rie
ENTRYPOINT [ "/entry_script.sh" ]
```
To use the arm64 architecture:
To use the arm64 architecture:
```
ADD aws-lambda-rie-arm64 /usr/local/bin/aws-lambda-rie
ENTRYPOINT [ "/entry_script.sh" ]
```
4. Build your image locally using the docker build command.
```
docker build -t myfunction:latest .
```
5. Run your image locally using the docker run command.
```
docker run -p 9000:8080 myfunction:latest
```
Expand All @@ -126,12 +131,14 @@ You install the runtime interface emulator to your local machine. When you run t
&& chmod +x ~/.aws-lambda-rie/aws-lambda-rie
```
To download the RIE for arm64 architecture, use the previous command with a different GitHub download url.
To download the RIE for arm64 architecture, use the previous command with a different GitHub download url.
```
https://github.com/aws/aws-lambda-runtime-interface-emulator/releases/latest/download/aws-lambda-rie-arm64 \
```
2. Run your Lambda image function using the docker run command.
```
docker run -d -v ~/.aws-lambda-rie:/aws-lambda -p 9000:8080 myfunction:latest
--entrypoint /aws-lambda/aws-lambda-rie <image entrypoint> <(optional) image command>`
Expand Down

0 comments on commit 6c827ea

Please sign in to comment.