Skip to content

Commit fa4aa55

Browse files
committed
Merge 'services' into 'master'
修改readmme See merge request: !14
2 parents 19a1c2d + d20c2c9 commit fa4aa55

File tree

4 files changed

+70
-13
lines changed

4 files changed

+70
-13
lines changed

README.EN.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@ English | [中文](README.md)
22

33
# Volcengine SDK for Node.js
44

5-
## Installation Core Packages
5+
## Installation
66

77
### Requirements
88

99
- Node.js >= 18
1010

1111
Recommended to use `pnpm` for installation. `npm` and `yarn` are also supported.
1212

13+
1. Installation Core Packages
14+
1315
```bash
1416
# pnpm
1517
pnpm add @volcengine/sdk-core
@@ -21,6 +23,21 @@ npm install @volcengine/sdk-core
2123
yarn add @volcengine/sdk-core
2224
```
2325

26+
2. Installation Service Packages
27+
28+
Take installing ECS service SDK package as an example:
29+
30+
```bash
31+
# pnpm
32+
pnpm add @volcengine/ecs
33+
34+
# npm
35+
npm install @volcengine/ecs
36+
37+
# yarn
38+
yarn add @volcengine/ecs
39+
```
40+
2441
## Environment Variables
2542

2643
The SDK automatically reads the following environment variables as access credentials:

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@
22

33
# Volcengine SDK for Node.js
44

5-
## 安装 Core 包
5+
## 安装
66

77
### 环境要求
88

99
- Node.js >= 18
1010

1111
推荐使用 `pnpm` 进行安装,同时支持 `npm``yarn`
1212

13+
1. 安装 Core 包
14+
1315
```bash
1416
# pnpm
1517
pnpm add @volcengine/sdk-core
@@ -21,6 +23,21 @@ npm install @volcengine/sdk-core
2123
yarn add @volcengine/sdk-core
2224
```
2325

26+
2. 安装云产品 SDK 包
27+
28+
以安装 ECS 业务 SDK 包为例:
29+
30+
```bash
31+
# pnpm
32+
pnpm add @volcengine/ecs
33+
34+
# npm
35+
npm install @volcengine/ecs
36+
37+
# yarn
38+
yarn add @volcengine/ecs
39+
```
40+
2441
## 环境变量设置
2542

2643
SDK 会自动读取以下环境变量作为访问凭据:
@@ -38,13 +55,6 @@ export VOLCSTACK_SECRET_ACCESS_KEY="YOUR_SK"
3855
## 快速开始
3956

4057
以下示例展示了如何初始化客户端并发送请求。
41-
安装对应的业务 SDK 包(如 `@volcengine/ecs`)。
42-
43-
```bash
44-
# pnpm
45-
pnpm add @volcengine/ecs
46-
47-
```
4858

4959
```typescript
5060
import { ECSClient, DescribeZonesCommand } from "@volcengine/ecs"; // 需安装对应的业务包

SDK_Integration.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ English | [中文](SDK_Integration_zh.md)
55
- [Environment and Installation](#environment-and-installation)
66
- [Environment Requirements](#environment-requirements)
77
- [Installation](#installation)
8-
- [Quick Start](#quick-start)
98
- [Credentials](#credentials)
109
- [AK/SK (Access Key)](#aksk-access-key)
1110
- [STS Token (Security Token Service)](#sts-token-security-token-service)
@@ -29,7 +28,6 @@ English | [中文](SDK_Integration_zh.md)
2928
- [Backoff Strategy](#backoff-strategy)
3029
- [Custom Retry Strategy](#custom-retry-strategy)
3130
- [Exception Handling](#exception-handling)
32-
- [Output Raw Response](#output-raw-response)
3331
- [Resource Cleanup](#resource-cleanup)
3432
- [Debug Mechanism](#debug-mechanism)
3533
- [Environment Variables Description](#environment-variables-description)
@@ -44,6 +42,8 @@ English | [中文](SDK_Integration_zh.md)
4442

4543
It is recommended to use `pnpm` for installation, but `npm` and `yarn` are also supported.
4644

45+
1. Installation Core Packages
46+
4747
```bash
4848
# pnpm
4949
pnpm add @volcengine/sdk-core
@@ -55,6 +55,21 @@ npm install @volcengine/sdk-core
5555
yarn add @volcengine/sdk-core
5656
```
5757

58+
2. Installation Service Packages
59+
60+
Take installing ECS service SDK package as an example:
61+
62+
```bash
63+
# pnpm
64+
pnpm add @volcengine/ecs
65+
66+
# npm
67+
npm install @volcengine/ecs
68+
69+
# yarn
70+
yarn add @volcengine/ecs
71+
```
72+
5873
## Credentials
5974

6075
The SDK supports multiple ways to configure credentials, with the following priority from high to low:

SDK_Integration_zh.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
- [环境与安装](#环境与安装)
66
- [环境要求](#环境要求)
77
- [安装](#安装)
8-
- [快速开始](#快速开始)
98
- [访问凭据](#访问凭据)
109
- [AK/SK (访问密钥)](#aksk-访问密钥)
1110
- [STS Token (临时凭证)](#sts-token-临时凭证)
@@ -29,7 +28,6 @@
2928
- [退避策略](#退避策略)
3029
- [自定义重试策略](#自定义重试策略)
3130
- [异常处理](#异常处理)
32-
- [输出原始文件](#输出原始文件)
3331
- [资源清理](#资源清理)
3432
- [Debug 机制](#debug-机制)
3533
- [环境变量说明](#环境变量说明)
@@ -44,6 +42,8 @@
4442

4543
推荐使用 `pnpm` 进行安装,同时支持 `npm``yarn`
4644

45+
1. 安装 Core 包
46+
4747
```bash
4848
# pnpm
4949
pnpm add @volcengine/sdk-core
@@ -55,6 +55,21 @@ npm install @volcengine/sdk-core
5555
yarn add @volcengine/sdk-core
5656
```
5757

58+
2. 安装云产品 SDK 包
59+
60+
以安装 ECS 业务 SDK 包为例:
61+
62+
```bash
63+
# pnpm
64+
pnpm add @volcengine/ecs
65+
66+
# npm
67+
npm install @volcengine/ecs
68+
69+
# yarn
70+
yarn add @volcengine/ecs
71+
```
72+
5873
## 访问凭据
5974

6075
SDK 支持多种方式配置访问凭据,优先级从高到低如下:

0 commit comments

Comments
 (0)