Skip to content

Commit 4e1f3ad

Browse files
authored
Update readme with installation instructions (#60)
1 parent d0e362e commit 4e1f3ad

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

+22
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,28 @@ This package provides a [custom
44
runtime](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-custom.html) for
55
AWS Lambda.
66

7+
## Installation
8+
9+
This repository provides two libraries:
10+
11+
- `lambda-runtime` provides a runtime and API for
12+
[AWS Lambda](https://aws.amazon.com/lambda/) and
13+
[API Gateway](https://aws.amazon.com/api-gateway/).
14+
- the `vercel` library depends on `lambda-runtime` and provides an interface to
15+
the [Vercel](https://vercel.com/) service that resembles a request / response
16+
exchange.
17+
18+
19+
The libraries in this repo are released to the OPAM package registry.
20+
21+
You can depend on them via:
22+
23+
1. [__esy__](esy): `esy add @opam/lambda-runtime` and / or `esy add @opam/vercel`
24+
2. [__OPAM__](opam): `opam install lambda-runtime vercel`.
25+
26+
[esy]: https://esy.sh
27+
[opam]: https://opam.ocaml.org
28+
729
## Example function
830

931
See the [`examples`](./examples) folder.

0 commit comments

Comments
 (0)