Skip to content

Commit 4da4fdc

Browse files
author
Riley Priddle
committed
Merge branch 'documentation' of https://github.com/FireTail-io/firetail-py-lambda into documentation
2 parents c7e0c61 + 69fd86f commit 4da4fdc

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,20 @@
22

33
[![PyPI package](https://img.shields.io/badge/pip%20install-firetail--lambda-brightgreen)](https://pypi.org/project/firetail-lambda/) [![version number](https://img.shields.io/pypi/v/firetail-lambda?color=green&label=version)](https://github.com/Firetail-io/firetail-py-lambda/releases) [![Actions Status](https://github.com/Firetail-io/firetail-py-lambda/workflows/Test/badge.svg)](https://github.com/Firetail-io/firetail-py-lambda/actions) [![License: LGPL v3](https://img.shields.io/badge/License-LGPL_v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) [![codecov](https://codecov.io/gh/FireTail-io/firetail-py-lambda/branch/main/graph/badge.svg?token=HU206RRZZ4)](https://codecov.io/gh/FireTail-io/firetail-py-lambda)
44

5-
###Overview
5+
### Overview
66

77
The purpose of this module is to correctly log out the AWS Lambda event and response payload to allow the firetail extension to then send it on to the firetail logging api
88

99
The firetail_handler is a decorator that wraps around an event handler function in a AWS Lambda to extract the event and response payloads into a base64 logging message.
1010

11+
1112
###Supported Lambda Runtimes
1213
✅ Python 3.7
1314
✅ Python 3.8
1415
✅ Python 3.9
1516

16-
###Installation
17+
18+
### Installation
1719
Install the module with using pip
1820
```bash
1921
pip install -U firetail-lambda
@@ -93,4 +95,4 @@ def lambda_handler(event, context):
9395
})
9496
}
9597

96-
```
98+
```

0 commit comments

Comments
 (0)