UNPKG

1.9 kBYAMLView Raw
1---
2#
3# This is the canonical configuration for the `README.md`
4# Run `make readme` to rebuild the `README.md`
5#
6
7# Name of this project
8name: node-aws-lambda-handlers
9
10# Tags of this project
11tags:
12 - aws
13 - aws-lambda
14 - nodejs
15 - handler
16 - typescript
17 - npm-package
18
19# Categories of this project
20categories:
21 - nodejs-modules/supported
22 - aws
23 - aws-lambda
24 - nodejs
25 - handler
26 - typescript
27 - npm-package
28
29# License of this project
30license: "APACHE2"
31
32# Canonical GitHub repo
33github_repo: enter-at/node-aws-lambda-handlers
34
35# Badges to display
36badges:
37 - name: "Build Status"
38 image: "https://github.com/enter-at/node-aws-lambda-handlers/workflows/Lint%20&%20Test/badge.svg"
39 url: "https://github.com/enter-at/node-aws-lambda-handlers/actions"
40 - name: "Release"
41 image: "https://img.shields.io/npm/v/@enter-at/node-aws-lambda-handlers.svg"
42 url: "https://www.npmjs.com/package/@enter-at/node-aws-lambda-handlers"
43 - name: "Install size"
44 image: "https://packagephobia.now.sh/badge?p=@enter-at/node-aws-lambda-handlers"
45 url: "https://packagephobia.now.sh/result?p=@enter-at/node-aws-lambda-handlers"
46
47# Short description of this project
48description: |-
49 An opinionated Typescript package that facilitates specifying AWS Lambda handlers including input validation,
50 error handling and response formatting.
51
52quickstart: |-
53 Install from NPM:
54 ```bash
55 npm install @enter-at/lambda-handlers
56 ```
57
58include:
59 - "docs/api.md"
60 - "docs/status-code.md"
61 - "docs/headers.md"
62 - "docs/errors.md"
63
64# Contributors to this project
65contributors:
66 - name: "Steffen Leistner"
67 github: "sleistner"
68 avatar: https://avatars0.githubusercontent.com/u/12568?s=128&v=4
69
70 - name: "Martin Pirkl"
71 github: "pirklmar"
72 avatar: https://avatars3.githubusercontent.com/u/2109537?s=128&v=4