Skip to content

Commit 15428eb

Browse files
committed
Include a README
1 parent 3a9b527 commit 15428eb

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

Diff for: README.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## Netlify Lambda CLI
2+
3+
This is a small CLI tool that helps with building or serving lambdas built with a simple webpack/babel setup.
4+
5+
The goal is to make it easy to work with Lambda's with modern ES6 without being dependent on having the most state of the art node runtime available in the final deployment environment and with a build that can compile all modules into a single lambda file.
6+
7+
## Usage
8+
9+
Netlify lambda installs two commands:
10+
11+
```
12+
netlify-lambda serve <folder>
13+
netlify-lambda build <folder>
14+
```
15+
16+
Both depends on a `netlify.toml` file being present in your project and configuring functions for deployment.
17+
18+
The `serve` function will start a dev server and a file watcher for the specified folder and route requests to the relevant function at:
19+
20+
```
21+
http://localhost:9000/hello -> folder/hello.js (must export a handler(event, context callback) function)
22+
```
23+
24+
The `build` function will run a single build of the functions in the folder.
25+
26+
## License
27+
28+
[MIT](LICENSE)

0 commit comments

Comments
 (0)