Skip to content

Commit 053aec5

Browse files
committed
update breaking change message
1 parent 1e1e918 commit 053aec5

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
Lambda API is a lightweight web framework for use with AWS API Gateway and AWS Lambda using Lambda Proxy integration. This closely mirrors (and is based on) other routers like Express.js, but is significantly stripped down to maximize performance with Lambda's stateless, single run executions.
1111

12-
**IMPORTANT:** There is a [breaking change](#breaking-change-in-v03) in v0.3
12+
**IMPORTANT:** There is a [breaking change](#breaking-change-in-v03) in v0.3 that affects instantiation.
1313

1414
## Simple Example
1515

@@ -39,7 +39,7 @@ Lambda API has **ONE** dependency. We use [Bluebird](http://bluebirdjs.com/docs/
3939
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, 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.
4040

4141
## Breaking Change in v0.3
42-
Please note that the invocation method has been changed. You no longer need to use the `new` keyword to initialize Lambda API. It can now be initialized in one line:
42+
Please note that the invocation method has been changed. You no longer need to use the `new` keyword to instantiate Lambda API. It can now be instantiated in one line:
4343

4444
```javascript
4545
const api = require('lambda-api')()
@@ -51,7 +51,7 @@ Please note that the invocation method has been changed. You no longer need to u
5151
const api = require('lambda-api')({ version: 'v1.0', base: 'v1' });
5252
```
5353

54-
**IMPORTANT:** Upgrading to v0.3.0 requires either removing the `new` keyword or switching to the one-line format. This provides more flexibility with initializing in future releases.
54+
**IMPORTANT:** Upgrading to v0.3.0 requires either removing the `new` keyword or switching to the one-line format. This provides more flexibility for instantiating Lambda API in future releases.
5555

5656
## Lambda Proxy integration
5757
Lambda Proxy Integration is an option in API Gateway that allows the details of an API request to be passed as the `event` parameter of a Lambda function. A typical API Gateway request event with Lambda Proxy Integration enabled looks like this:

0 commit comments

Comments
 (0)