Skip to content

Commit 6c827ea

Browse files
author
Callum Bodels
authored
docs: corrected bullet point's content spacing/indentation (#81)
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.
1 parent ee52c16 commit 6c827ea

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

+12-5
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,10 @@ You can build RIE into a base image. Download the RIE from GitHub to your local
7575

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

78-
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.
78+
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.
79+
80+
The following example shows a typical script for a Node.js function.
7981

80-
The following example shows a typical script for a Node.js function.
8182
```
8283
#!/bin/sh
8384
if [ -z "${AWS_LAMBDA_RUNTIME_API}" ]; then
@@ -91,24 +92,28 @@ The following example shows a typical script for a Node.js function.
9192
9293
3. Install the emulator package and change `ENTRYPOINT` to run the new script by adding the following lines to your Dockerfile:
9394
94-
To use the default x86\_64 architecture
95+
To use the default x86\_64 architecture
96+
9597
```
9698
ADD aws-lambda-rie /usr/local/bin/aws-lambda-rie
9799
ENTRYPOINT [ "/entry_script.sh" ]
98100
```
99101
100-
To use the arm64 architecture:
102+
To use the arm64 architecture:
103+
101104
```
102105
ADD aws-lambda-rie-arm64 /usr/local/bin/aws-lambda-rie
103106
ENTRYPOINT [ "/entry_script.sh" ]
104107
```
105108
106109
4. Build your image locally using the docker build command.
110+
107111
```
108112
docker build -t myfunction:latest .
109113
```
110114
111115
5. Run your image locally using the docker run command.
116+
112117
```
113118
docker run -p 9000:8080 myfunction:latest
114119
```
@@ -126,12 +131,14 @@ You install the runtime interface emulator to your local machine. When you run t
126131
&& chmod +x ~/.aws-lambda-rie/aws-lambda-rie
127132
```
128133
129-
To download the RIE for arm64 architecture, use the previous command with a different GitHub download url.
134+
To download the RIE for arm64 architecture, use the previous command with a different GitHub download url.
135+
130136
```
131137
https://github.com/aws/aws-lambda-runtime-interface-emulator/releases/latest/download/aws-lambda-rie-arm64 \
132138
```
133139
134140
2. Run your Lambda image function using the docker run command.
141+
135142
```
136143
docker run -d -v ~/.aws-lambda-rie:/aws-lambda -p 9000:8080 myfunction:latest
137144
--entrypoint /aws-lambda/aws-lambda-rie <image entrypoint> <(optional) image command>`

0 commit comments

Comments
 (0)