Skip to content

Commit

Permalink
Remove mention of docker provider
Browse files Browse the repository at this point in the history
  • Loading branch information
TooTallNate committed Oct 30, 2021
1 parent d95c39f commit f75467e
Showing 1 changed file with 3 additions and 26 deletions.
29 changes: 3 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,14 @@
# ƒun

[![Build Status](https://github.com/vercel/fun/workflows/Node%20CI/badge.svg)](https://github.com/vercel/fun/actions?workflow=Node+CI)

Local serverless function λ development runtime.

* Programmatic. A TypeScript API is exposed to trigger invocations.
* Provider agnostic. AWS Lambda + other cloud providers planned.
* Runtime agnostic. Node, go, python and custom runtime APIs.
* Platform agnostic. Functions can be executed natively (e.g. macOS) or via Docker.
* Zero setup needed. ƒun acquires the necessary runtime files (e.g. `node`).


## Example

Given a Lambda function like this one:

```js
// index.js
// example/index.js
exports.handler = function(event, context, callback) {
callback(null, { hello: 'world' });
};
Expand Down Expand Up @@ -59,17 +51,9 @@ async function main() {
main().catch(console.error);
```

## Caveats

## Providers

ƒun has a concept of pluggable "providers", which are responsible for
creating, freezing, unfreezing and shutting down the processes that execute the
Lambda function.

### `native`

The `native` provider executes Lambda functions directly on the machine executing
ƒun. This provides an execution environment that closely resembles the
ƒun provides an execution environment that closely resembles the
real Lambda environment, with some key differences that are documented here:

* Lambdas processes are ran as your own user, not the `sbx_user1051` user.
Expand All @@ -83,13 +67,6 @@ real Lambda environment, with some key differences that are documented here:
for your operating system. So if you are on macOS, then the binary needs to be
executable on macOS.

### `docker`

A `docker` provider is planned, but not yet implemented. This will allow for an
execution environment that more closely matches the AWS Lambda environment,
including the ability to execute Linux x64 binaries / shared libraries.


## Runtimes

ƒun aims to support all runtimes that AWS Lambda provides. Currently
Expand Down

0 comments on commit f75467e

Please sign in to comment.