README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: node-aws-lambda-handlers

# Tags of this project
tags:
    - aws
    - aws-lambda
    - nodejs
    - handler
    - typescript
    - npm-package

# Categories of this project
categories:
    - nodejs-modules/supported
    - aws
    - aws-lambda
    - nodejs
    - handler
    - typescript
    - npm-package

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: enter-at/node-aws-lambda-handlers

# Badges to display
badges:
    - name: "Build Status"
      image: "https://github.com/enter-at/node-aws-lambda-handlers/workflows/Lint%20&%20Test/badge.svg"
      url: "https://github.com/enter-at/node-aws-lambda-handlers/actions"
    - name: "Release"
      image: "https://img.shields.io/npm/v/@enter-at/lambda-handlers.svg"
      url: "https://www.npmjs.com/package/@enter-at/lambda-handlers"
    - name: "Install size"
      image: "https://packagephobia.com/badge?p=@enter-at/lambda-handlers"
      url: "https://packagephobia.com/result?p=@enter-at/lambda-handlers"
    - name: "Code Climate Maintainability"
      image: "https://api.codeclimate.com/v1/badges/9a0d3859c2196e212e96/maintainability"
      url: "https://codeclimate.com/github/enter-at/node-aws-lambda-handlers/maintainability"
    - name: "Code Climate Test Coverage"
      image: "https://api.codeclimate.com/v1/badges/9a0d3859c2196e212e96/test_coverage"
      url: "https://codeclimate.com/github/enter-at/node-aws-lambda-handlers/test_coverage"

related:
  - name: "python-aws-lambda-handlers"
    description: |
        An opinionated Python module that facilitates specifying AWS Lambda handlers including
        input validation, error handling and response formatting.
    url: "https://github.com/enter-at/python-aws-lambda-handlers"

# Short description of this project
description: |-
    An opinionated Typescript package that facilitates specifying AWS Lambda handlers including input validation,
    error handling and response formatting.

quickstart: |-
    Install from NPM:
    ```bash
    npm install @enter-at/lambda-handlers
    ```

include:
    - "docs/api.md"
    - "docs/status-code.md"
    - "docs/headers.md"
    - "docs/errors.md"