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

Commit 9cc96c3

Browse files
committed
chore: update README
1 parent e38f90e commit 9cc96c3

File tree

2 files changed

+26
-3
lines changed

2 files changed

+26
-3
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,34 @@
1+
# @netlify/functions
2+
13
[![Build](https://github.com/netlify/functions-js/workflows/Build/badge.svg)](https://github.com/netlify/functions-js/actions)
24
[![Coverage Status](https://codecov.io/gh/netlify/functions-js/branch/master/graph/badge.svg)](https://codecov.io/gh/netlify/functions-js)
35
[![Node](https://img.shields.io/node/v/@netlify/functions.svg?logo=node.js)](https://www.npmjs.com/package/@netlify/functions)
46

5-
# functions-js
6-
77
JavaScript utilities for Netlify Functions.
88

9+
## Installation
10+
11+
```
12+
npm install @netlify/functions
13+
```
14+
15+
## Usage
16+
17+
### Builder Functions
18+
19+
```js
20+
const { builderFunction } = require('@netlify/functions')
21+
22+
const handler = async (event, context) => {
23+
return {
24+
statusCode: 200,
25+
body: JSON.stringify({ message: 'Hello World' }),
26+
}
27+
}
28+
29+
exports.handler = builderFunction(handler)
30+
```
31+
932
## Contributors
1033

1134
Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for instructions on how to set up and work on this repository. Thanks

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
"test:ci:ava": "nyc -r lcovonly -r text -r json ava"
2626
},
2727
"config": {
28-
"eslint": "--ignore-path .gitignore --cache --format=codeframe --max-warnings=0 \"{src,scripts,.github}/**/*.{js,md,html}\" \"*.{js,md,html}\" \".*.{js,md,html}\"",
28+
"eslint": "--ignore-pattern 'README.md' --ignore-path .gitignore --cache --format=codeframe --max-warnings=0 \"{src,scripts,.github}/**/*.{js,md,html}\" \"*.{js,md,html}\" \".*.{js,md,html}\"",
2929
"prettier": "--ignore-path .gitignore --loglevel=warn \"{src,scripts,.github}/**/*.{js,md,yml,json,html}\" \"*.{js,yml,json,html}\" \".*.{js,yml,json,html}\" \"!**/package-lock.json\" \"!package-lock.json\""
3030
},
3131
"ava": {

0 commit comments

Comments
 (0)