Skip to content

Commit 9f1cf70

Browse files
committed
docs: update readme
1 parent cb3f8d4 commit 9f1cf70

File tree

2 files changed

+44
-44
lines changed

2 files changed

+44
-44
lines changed

README.en.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Tencent Flask Serverless Component
44

5-
[简体中文](https://github.com/serverless-components/tencent-flask/blob/master/README.md) | English
5+
[简体中文](./README.md) | English
66

77
## Introduction
88

@@ -78,28 +78,28 @@ TENCENT_SECRET_KEY=XXX
7878
```yml
7979
# serverless.yml
8080

81-
MyComponent:
82-
component: '@serverless/tencent-flask'
83-
inputs:
84-
region: ap-guangzhou
85-
functionName: flask-function
86-
code: ./
87-
functionConf:
88-
timeout: 10
89-
memorySize: 128
90-
environment:
91-
variables:
92-
TEST: vale
93-
vpcConfig:
94-
subnetId: ''
95-
vpcId: ''
96-
apigatewayConf:
97-
protocols:
98-
- https
99-
environment: release
81+
component: flask
82+
name: flashDemo
83+
org: orgDemo
84+
app: appDemo
85+
stage: dev
86+
87+
inputs:
88+
src:
89+
hook: 'pip install -r requirements.txt -t ./'
90+
dist: ./
91+
exclude:
92+
- .env
93+
region: ap-guangzhou
94+
runtime: Python3.6
95+
apigatewayConf:
96+
protocols:
97+
- http
98+
- https
99+
environment: release
100100
```
101101
102-
- [More Options](https://github.com/serverless-components/tencent-flask/blob/master/docs/configure.md)
102+
- [More Options](./docs/configure.md))
103103
104104
### 4. Deploy
105105

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# 腾讯云 Flask Serverless Component
44

5-
简体中文 | [English](https://github.com/serverless-components/tencent-flask/blob/master/README.en.md)
5+
简体中文 | [English](./README.en.md)
66

77
## 简介
88

@@ -18,7 +18,7 @@
1818
1. [部署](#3-部署)
1919
1. [移除](#4-移除)
2020

21-
### 0. 准备 `
21+
### 0. 准备
2222

2323
在使用此组件之前,需要先初始化一个 Flask 项目,然后将 `Flask``werkzeug` 添加到依赖文件 `requirements.txt` 中,如下:
2424

@@ -66,28 +66,28 @@ $ touch serverless.yml
6666
```yml
6767
# serverless.yml
6868

69-
MyComponent:
70-
component: '@serverless/tencent-flask'
71-
inputs:
72-
region: ap-guangzhou
73-
functionName: flask-function
74-
code: ./
75-
functionConf:
76-
timeout: 10
77-
memorySize: 128
78-
environment:
79-
variables:
80-
TEST: vale
81-
vpcConfig:
82-
subnetId: ''
83-
vpcId: ''
84-
apigatewayConf:
85-
protocols:
86-
- https
87-
environment: release
69+
component: flask
70+
name: flashDemo
71+
org: orgDemo
72+
app: appDemo
73+
stage: dev
74+
75+
inputs:
76+
src:
77+
hook: 'pip install -r requirements.txt -t ./'
78+
dist: ./
79+
exclude:
80+
- .env
81+
region: ap-guangzhou
82+
runtime: Python3.6
83+
apigatewayConf:
84+
protocols:
85+
- http
86+
- https
87+
environment: release
8888
```
8989
90-
- [更多配置](https://github.com/serverless-components/tencent-flask/blob/master/docs/configure.md)
90+
- [更多配置](./docs/configure.md)
9191
9292
### 3. 部署
9393
@@ -129,4 +129,4 @@ TENCENT_SECRET_KEY=123
129129

130130
### 更多组件
131131

132-
可以在 [Serverless Components](https://github.com/serverless/components) repo 中查询更多组件的信息。
132+
可以在 [Serverless Components](https://github.com/serverless/components/blob/master/README.cn.md) repo 中查询更多组件的信息。

0 commit comments

Comments
 (0)