Skip to content
This repository was archived by the owner on Apr 24, 2025. It is now read-only.

Commit d332400

Browse files
committed
docs(readme): Add new function properties
1 parent 7c29df1 commit d332400

File tree

1 file changed

+25
-4
lines changed

1 file changed

+25
-4
lines changed

README.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
Serverless Optimize Plugin
22
=============================
3-
[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)
3+
[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)
4+
[![npm version](https://badge.fury.io/js/serverless-plugin-optimize.svg)](https://badge.fury.io/js/serverless-plugin-optimize)
5+
[![dependencies](https://img.shields.io/david/FidelLimited/serverless-plugin-optimize.svg)](https://www.npmjs.com/package/serverless-plugin-optimize)
6+
[![license](https://img.shields.io/npm/l/serverless-plugin-optimize.svg)](https://raw.githubusercontent.com/FidelLimited/serverless-plugin-optimize/master/LICENSE)
47

58
Bundle with Browserify, transpile with Babel to ES5 and minify with Uglify your Serverless functions.
69

@@ -53,7 +56,7 @@ custom:
5356
exclude: ['ajv']
5457
```
5558

56-
* **minify** (default `true`) - When mininify is set to `false` your functions won't be minified.
59+
* **minify** (default `true`) - When minify is set to `false` your functions won't be minified.
5760

5861
```yml
5962
custom:
@@ -79,15 +82,15 @@ custom:
7982

8083
#### Function
8184

82-
* **optimize** (default `true`) - When optimize is set to `false` the specific function won't be optimized.
85+
* **optimize** (default `true`) - When optimize is set to `false` the function won't be optimized.
8386

8487
```yml
8588
functions:
8689
hello:
8790
optimize: false
8891
```
8992

90-
* **exclude** - Array of modules that will be excluded from the specific function.
93+
* **exclude** - Array of modules that will be excluded from the function.
9194

9295
```yml
9396
functions:
@@ -96,6 +99,24 @@ functions:
9699
exclude: ['ajv']
97100
```
98101

102+
* **minify** - When minify is set to `false` the function won't be minified.
103+
104+
```yml
105+
functions:
106+
hello:
107+
optimize:
108+
minify: false
109+
```
110+
111+
* **presets** - Array of Babel presets for the function.
112+
113+
```yml
114+
functions:
115+
hello:
116+
optimize:
117+
presets: ['es2016']
118+
```
119+
99120
## Contribute
100121

101122
Help us making this plugin better and future proof.

0 commit comments

Comments
 (0)