Permalink
Browse files

add toc to readme

  • Loading branch information...
jeremydaly committed May 18, 2018
1 parent 7b01883 commit 7c1dc43ac0dce7227e586e1e073bd0b882650156
Showing with 44 additions and 0 deletions.
  1. +44 −0 README.md
@@ -37,6 +37,50 @@ Lambda API has **ZERO** dependencies.

Lambda API was written to be extremely lightweight and built specifically for serverless applications using AWS Lambda. It provides support for API routing, serving up HTML pages, issuing redirects, serving binary files and much more. It has a powerful middleware and error handling system, allowing you to implement everything from custom authentication to complex logging systems. Best of all, it was designed to work with Lambda's Proxy Integration, automatically handling all the interaction with API Gateway for you. It parses **REQUESTS** and formats **RESPONSES** for you, allowing you to focus on your application's core functionality, instead of fiddling with inputs and outputs.

## Table of Contents
- [Installation](#installation)
- [Requirements](#requirements)
- [Configuration](#configuration)
- [Recent Updates](##recent-updates)
- [Routes and HTTP Methods](#routes-and-http-methods)
- [Returning Responses](#returning-responses)
- [Async/Await](#asyncawait)
- [Promises](#promises)
- [Route Prefixing](#route-prefixing)
- [Debugging Routes](#debugging-routes)
- [REQUEST](#request)
- [RESPONSE](#response)
- [attachment()](#attachmentfilename)
- [clearCookie()](#clearcookiename-options)
- [cookie()](#cookiename-value-options)
- [cors()](#corsoptions)
- [download()](#downloadfile--filename--options--callback)
- [error()](#errormessage)
- [etag()](#etagboolean)
- [getHeader()](#getheaderkey)
- [hasHeader()](#hasheaderkey)
- [header()](#headerkey-value)
- [html()](#htmlbody)
- [json()](#jsonbody)
- [jsonp()](#jsonpbody)
- [location](#locationpath)
- [redirect()](#redirectstatus-path)
- [removeHeader()](#removeheaderkey)
- [send()](#sendbody)
- [sendFile()](#sendfilefile--options--callback)
- [status()](#statuscode)
- [type()](#typetype)
- [Enabling Binary Support](#enabling-binary-support)
- [Path Parameters](#path-parameters)
- [Wildcard Routes](#wildcard-routes)
- [Middleware](#middleware)
- [Clean Up](#clean-up)
- [Error Handling](#error-handling)
- [Namespaces](#namespaces)
- [CORS Support](#cors-support)
- [Lambda Proxy Integration](#lambda-proxy-integration)
- [Configuring Routes in API Gateway](#configuring-routes-in-api-gateway)
- [Contributions](#contributions)

## Installation
```

0 comments on commit 7c1dc43

Please sign in to comment.