Skip to content

Commit

Permalink
doc: update readme with more badage
Browse files Browse the repository at this point in the history
Signed-off-by: seven <zilisheng1996@gmail.com>
  • Loading branch information
Blankll committed Oct 20, 2024
1 parent 87cb4ba commit 7125a7a
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,30 @@
# Serverless-Adapter

[![Node.js CI](https://github.com/geek-fun/serverless-adapter/actions/workflows/node.yml/badge.svg)](https://github.com/geek-fun/serverless-adapter/actions/workflows/node.yml)
[![release](https://github.com/geek-fun/serverless-adapter/actions/workflows/release.yml/badge.svg)](https://github.com/geek-fun/serverless-adapter/actions/workflows/release.yml)
[![npm version](https://badge.fury.io/js/@geek-fun%2Fserverless-adapter.svg)](https://badge.fury.io/js/@geek-fun%2Fserverless-adapter)
[![Known Vulnerabilities](https://snyk.io/test/github/geek-fun/serverless-adapter/badge.svg)](https://snyk.io/test/github/geek-fun/serverless-adapter)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![codecov](https://codecov.io/gh/geek-fun/serverless-adapter/graph/badge.svg?token=lw1AJuX9S9)](https://codecov.io/gh/geek-fun/serverless-adapter)

adapter for web framework express, koa, springboot to run in serverless function as backend of apigateway corss multi
Adapter for web framework express, koa, springboot to run on top of serverless API Gateway and Functions cross different
cloud provider like aliyun, huawei

## Quick Start

### prerequisites

- Node.js >= 16.x

### Install

```bash
npm install -g @geek-fun/serverless-adapter
```

### Usage

```typescript
const app = express();
export const handler = serverlessAdapter(app)
```

0 comments on commit 7125a7a

Please sign in to comment.