Skip to content

Commit 45c99cd

Browse files
committed
docs: update readme
1 parent d08f1b8 commit 45c99cd

File tree

2 files changed

+40
-7
lines changed

2 files changed

+40
-7
lines changed

README.md

Lines changed: 39 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
1-
# 腾讯云 SDK
1+
# Tencent Cloud SDK
22

3-
## 云 API 接口使用方法
3+
[![npm](https://img.shields.io/npm/v/tencent-cloud-sdk)](http://www.npmtrends.com/tencent-cloud-sdk)
4+
[![NPM downloads](http://img.shields.io/npm/dm/tencent-cloud-sdk.svg?style=flat-square)](http://www.npmtrends.com/tencent-cloud-sdk)
5+
[![Build Status](https://travis-ci.com/serverless-tencent/tencent-cloud-sdk.svg?branch=master)](https://travis-ci.com/serverless-tencent/tencent-cloud-sdk)
6+
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
7+
8+
## How to using Cloud API?
49

510
```
611
const { apigw } = require('../lib/index')
@@ -20,9 +25,9 @@ apigwClient.request(data)
2025
2126
```
2227

23-
参考地址: https://cloud.tencent.com/document/api
28+
Refer to: https://cloud.tencent.com/document/api
2429

25-
## COS 接口使用方法
30+
## How to use COS?
2631

2732
```
2833
const { cos } = require('../lib/index')
@@ -39,9 +44,9 @@ cosClient.getService(function(err, data) {
3944
});
4045
```
4146

42-
参考地址:https://cloud.tencent.com/document/product/436/8629
47+
Refer to: https://cloud.tencent.com/document/product/436/8629
4348

44-
## Scf 监控接口
49+
## Monitor for SCF
4550

4651
```
4752
const { slsMonitor } = require('./src/index')
@@ -57,4 +62,31 @@ const ret = await slsClient.getScfMetrics('ap-guangzhou', rangeTime, period, 'fu
5762
console.log(ret)
5863
```
5964

60-
参考地址: https://cloud.tencent.com/document/product/248/31649
65+
Refer to: https://cloud.tencent.com/document/product/248/31649
66+
67+
## Development
68+
69+
All `git commit` mesage must follow below syntax:
70+
71+
```bash
72+
type(scope?): subject #scope is optional
73+
```
74+
75+
support type:
76+
77+
```bash
78+
- **feat**: add new feature
79+
- **fix**: fix bug or patch feature
80+
- **ci**: CI
81+
- **chore**: modify config, nothing to do with production code
82+
- **docs**: create or modifiy documents
83+
- **refactor**: refactor project
84+
- **revert**: revert
85+
- **test**: test
86+
```
87+
88+
Most of time, we just use `feat` and `fix`.
89+
90+
## License
91+
92+
Copyright (c) 2019-present Tencent Cloud, Inc.

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
},
99
"keywords": [
1010
"Tencent Cloud",
11+
"Tencent Cloud SDK",
1112
"Serverless Framework",
1213
"Cloud function"
1314
],

0 commit comments

Comments
 (0)