Skip to content

Commit 7125a7a

Browse files
committed
doc: update readme with more badage
Signed-off-by: seven <[email protected]>
1 parent 87cb4ba commit 7125a7a

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,30 @@
11
# Serverless-Adapter
22

33
[![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)
4+
[![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)
5+
[![npm version](https://badge.fury.io/js/@geek-fun%2Fserverless-adapter.svg)](https://badge.fury.io/js/@geek-fun%2Fserverless-adapter)
6+
[![Known Vulnerabilities](https://snyk.io/test/github/geek-fun/serverless-adapter/badge.svg)](https://snyk.io/test/github/geek-fun/serverless-adapter)
7+
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
8+
[![codecov](https://codecov.io/gh/geek-fun/serverless-adapter/graph/badge.svg?token=lw1AJuX9S9)](https://codecov.io/gh/geek-fun/serverless-adapter)
49

5-
adapter for web framework express, koa, springboot to run in serverless function as backend of apigateway corss multi
10+
Adapter for web framework express, koa, springboot to run on top of serverless API Gateway and Functions cross different
611
cloud provider like aliyun, huawei
12+
13+
## Quick Start
14+
15+
### prerequisites
16+
17+
- Node.js >= 16.x
18+
19+
### Install
20+
21+
```bash
22+
npm install -g @geek-fun/serverless-adapter
23+
```
24+
25+
### Usage
26+
27+
```typescript
28+
const app = express();
29+
export const handler = serverlessAdapter(app)
30+
```

0 commit comments

Comments
 (0)