Skip to content

Commit 349e60a

Browse files
committed
Updated README with Handler info
1 parent ebd1ebf commit 349e60a

File tree

3 files changed

+18
-6
lines changed

3 files changed

+18
-6
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Changelog
2-
## [1.0.0] - 2017-06-26
2+
## [1.0.0] - 2017-06-25
33
- Initial release

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# aws-lambda-deploy
22
## Usage
33

4-
```
4+
```bash
55
gald [command] [option]
66
```
77

88
There are 3 commands available
9-
```
9+
```bash
1010
gald init
1111
gald test
1212
gald deploy
@@ -24,12 +24,24 @@ After running `init` you should consider
2424
adding `lambda-secrets.json`
2525
to your `.gitignore`.
2626

27+
The `Handler` property consists of
28+
the module name and the function name.
29+
30+
For example a file `handler.js` with:
31+
```javascript
32+
exports.myHandler = function () {};
33+
```
34+
The resulting `Handler` property looks like this:
35+
```
36+
"Handler": "handler.myHandler"
37+
```
38+
2739
#### test
2840

2941
Execute all defined tests in `lambda-test.json`
3042
or a different JSON file.
3143

32-
```
44+
```bash
3345
gald test [optional json file]
3446
```
3547

@@ -47,7 +59,7 @@ with the necessary components
4759
for the AWS Lambda function.
4860

4961
For example, have a build script that looks like this:
50-
```
62+
```bash
5163
zip -r -9 archive.zip handler.js
5264
```
5365
If your AWS Lambda function depends on other packages,

tsconfig.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
]
1313
},
1414
"file": [
15-
"src/gdw-aws-lambda.ts"
15+
"src/main.ts"
1616
],
1717
"exclude": [
1818
"node_modules"

0 commit comments

Comments
 (0)