Skip to content
This repository was archived by the owner on Sep 8, 2021. It is now read-only.

Commit 3a06395

Browse files
committed
Update README
1 parent 5bc4efe commit 3a06395

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,22 @@
1-
# Netlify Lambda for Vue CLI
1+
# vue-cli-plugin-netlify-lambda
2+
3+
> netlify-lambda plugin for vue-cli
4+
5+
Sets up [netlify-lambda](https://github.com/netlify/netlify-lambda) for vue-cli projects to build and serve AWS lambda functions.
6+
7+
## Installing in an Already Created Project
8+
9+
```
10+
vue add netlify-lambda
11+
```
12+
13+
## Usage
14+
15+
This ads a `netlify.toml` and a `src/lambda` folder with an example `hello.js` lambda function.
16+
17+
Any js file added in `src/lambda` will be built as a lambda. It will be compiled with webpack and babel and any imports will be bundled (no native dependencies, though).
18+
19+
When deployed to Netlify, the AWS lambda's are reachable under `/.netlify/functions/:name` - ie, the `hello.js` Lambda will be available under `/.netlify/functions/hello`.
20+
21+
The plugin also sets up a proxy and runs the Lambdas locally, to simplify local development.
222

0 commit comments

Comments
 (0)