Skip to content

Commit

Permalink
docs: refine readme
Browse files Browse the repository at this point in the history
  • Loading branch information
CCharlieLi committed Feb 16, 2021
1 parent 2fc21a1 commit ac8a3f5
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This is a library for integrating with AliCloud live-streaming platform - [Apsar

Integration progress:
- [x] [get domains](https://www.alibabacloud.com/help/doc-detail/88332.htm?spm=a2c63.p38356.b99.143.17872c80zDTOBs)
- TBD
- [ ] TBD

### How to use
```js
Expand Down Expand Up @@ -36,18 +36,18 @@ const domainsData: ApsaraDomainsData = await apsara.getDomains()
// PageNumber: 1
```

### Document
### Specs

#### Apsara(options [,logger])
- **options**, required
- accessKeyId: string, required
- accessKeySecret: string, required
- baseUrl?: string, default `'https://live.aliyuncs.com'`
- timeout?: number, default `3000`
- version?: string, default `'2016-11-01'`
- signatureMethod?: string, default `'HMAC-SHA1'`
- signatureVersion?: string, default `'1.0'`
- format?: string, default `'json'`
- `accessKeyId`: string, required
- `accessKeySecret`: string, required
- `baseUrl`?: string, by default `'https://live.aliyuncs.com'`
- `timeout`?: number, by default `3000`
- `version`?: string, by default `'2016-11-01'`
- `signatureMethod`?: string, by default `'HMAC-SHA1'`
- `signatureVersion`?: string, by default `'1.0'`
- `format`?: string, by default `'json'`
- **logger**, optional, WinstonLogger/BunyanLogger/Console

#### [Apsara.getDomains()](https://www.alibabacloud.com/help/doc-detail/88332.htm?spm=a2c63.p38356.b99.143.17872c80zDTOBs)
Expand All @@ -59,4 +59,4 @@ yarn
yarn test
```

### MIT License
### [MIT License](https://github.com/CCharlieLi/alicloud-apsara/blob/master/License)

0 comments on commit ac8a3f5

Please sign in to comment.