Skip to content

Commit 9a436e3

Browse files
committed
docs: Improving README file
1 parent 563ecdc commit 9a436e3

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,26 @@
1-
## My Project
1+
# Lambda Powertools
22

3-
TODO: Fill this README out!
3+
![aws provider](https://img.shields.io/badge/provider-AWS-orange?logo=amazon-aws&color=ff9900)
44

5-
Be sure to:
65

7-
* Change the title in this README
8-
* Edit your repository description on GitHub
6+
A suite of utilities for AWS Lambda Functions that makes tracing with AWS X-Ray, structured logging and creating custom metrics asynchronously easier.
97

10-
## Security
8+
**[📜Documentation](https://awslabs.github.io/aws-lambda-powertools-java/)** | **[Feature request](https://github.com/awslabs/aws-lambda-powertools-java/issues/new?assignees=&labels=feature-request%2C+triage&template=feature_request.md&title=)** | **[🐛Bug Report](https://github.com/awslabs/aws-lambda-powertools-java/issues/new?assignees=&labels=bug%2C+triage&template=bug_report.md&title=)** | **[Detailed blog post](https://aws.amazon.com/blogs/opensource/simplifying-serverless-best-practices-with-lambda-powertools/)**
119

12-
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
10+
### Installation
11+
12+
With [pip](https://pip.pypa.io/en/latest/index.html) installed, run: ``pip install aws-lambda-powertools``
13+
14+
## Example
15+
16+
See **[example](./example/README.md)** of all features, testing, and a SAM template with all Powertools env vars. All features also provide full docs, and code completion for VSCode and PyCharm.
17+
18+
## Credits
19+
20+
* Structured logging initial implementation from [aws-lambda-logging](https://gitlab.com/hadrien/aws_lambda_logging)
21+
* Powertools idea [DAZN Powertools](https://github.com/getndazn/dazn-lambda-powertools/)
22+
* [Gatsby Apollo Theme for Docs](https://github.com/apollographql/gatsby-theme-apollo/tree/master/packages/gatsby-theme-apollo-docs)
1323

1424
## License
1525

1626
This library is licensed under the MIT-0 License. See the LICENSE file.
17-

0 commit comments

Comments
 (0)