Skip to content

Commit 17aa7cd

Browse files
committed
chore: update README
1 parent fa83a4b commit 17aa7cd

File tree

1 file changed

+38
-27
lines changed

1 file changed

+38
-27
lines changed

README.md

Lines changed: 38 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,7 @@
5353

5454
</details>
5555

56-
## Usage
57-
58-
[API Reference](https://jike-sdk.surge.sh/)
56+
## Installation
5957

6058
### Node.js
6159

@@ -71,63 +69,76 @@ npm i jike-sdk
7169

7270
```ts
7371
// 自带 node-fetch
74-
import { api, setAccessToken, ApiClient } from 'jike-sdk/node'
72+
import { setApiConfig } from 'jike-sdk/node'
7573

7674
// 不带 node-fetch,需要自行 ployfill 或使用最新 Node.js
7775
// import { api, setAccessToken, ApiClient } from 'jike-sdk'
7876

79-
setAccessToken('your access token')
80-
api.userRelation.getFollowingList('82D23B32-CF36-4C59-AD6F-D05E3552CBF3', {
81-
limit: 100,
77+
setApiConfig({
78+
// ...
8279
})
83-
84-
// Or
85-
const client = ApiClient('your access token')
86-
client.users.profile()
8780
```
8881

8982
#### CJS 导入
9083

9184
```ts
9285
;(async () => {
93-
const { setAccessToken, getAccessToken } = await import('jike-sdk/node')
94-
setAccessToken('your access token')
95-
console.log(getAccessToken())
86+
const { setApiConfig } = await import('jike-sdk/node')
87+
setApiConfig({
88+
// ...
89+
})
9690
})()
9791
```
9892

9993
### Deno
10094

10195
```ts
102-
import { setAccessToken, api } from 'https://cdn.skypack.dev/jike-sdk?dts'
103-
104-
setAccessToken('your access token')
105-
api.users.getSmsCode('+86', 'your mobile phone')
96+
import { setApiConfig } from 'https://cdn.skypack.dev/jike-sdk?dts'
10697
```
10798

10899
### 浏览器
109100

110101
```ts
111-
import { setAccessToken } from 'jike-sdk'
112-
113-
setAccessToken('your access token')
102+
import { setApiConfig } from 'jike-sdk'
114103
```
115104

116105
或使用 CDN 的方式加载(与 Deno 一致)
117106

118107
```html
119108
<script type="module">
120-
import {
121-
setAccessToken,
122-
getAccessToken,
123-
} from 'https://cdn.skypack.dev/jike-sdk'
124-
setAccessToken('your access token')
125-
console.log(getAccessToken())
109+
import { setApiConfig } from 'https://cdn.skypack.dev/jike-sdk'
126110
</script>
127111
```
128112

129113
**由于 CORS 策略的原因,第三方网站无法直接请求外部服务器。但可以使用浏览器扩展的能力请求。**
130114

115+
## Usage
116+
117+
[API Reference](https://jike-sdk.surge.sh/)
118+
119+
```ts
120+
import { setApiConfig, setAccessToken, api, ApiClient } from 'jike-sdk'
121+
122+
const apiConfig = {
123+
endpointId: 'jike',
124+
endpointUrl: '<jike-endpoint-url>', // 请自行替换
125+
bundleId: '<bundle-id>', // 请自行替换
126+
buildNo: '<build-no>', // 请自行替换
127+
userAgent: '<jike-sdk-user-agent>', // 请自行替换
128+
accessToken: '<access-token>', // 请自行替换
129+
}
130+
setApiConfig(apiConfig)
131+
132+
setAccessToken('update-access-token')
133+
api.userRelation.getFollowingList('82D23B32-CF36-4C59-AD6F-D05E3552CBF3', {
134+
limit: 100,
135+
})
136+
137+
// 或使用 ApiClient
138+
const client = ApiClient(apiConfig)
139+
client.users.profile()
140+
```
141+
131142
## Alternatives
132143

133144
- [jike-cli](https://github.com/junbaor/jike-cli) - 即刻命令行客户端 (Java)

0 commit comments

Comments
 (0)