Skip to content

Commit d28bbf5

Browse files
committed
[docs] clarify http client defaults
1 parent 30c8a58 commit d28bbf5

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
[![GitHub Stars](https://img.shields.io/github/stars/android-sms-gateway/client-ts.svg?style=for-the-badge)](https://github.com/android-sms-gateway/client-ts/stargazers)
88
[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg?style=for-the-badge)](https://www.typescriptlang.org/)
99

10-
A TypeScript-first client for seamless integration with the [SMS Gateway for Android](https://sms-gate.app) API. Programmatically send SMS messages through your Android devices with strict typing and modern JavaScript features.
10+
A TypeScript-first client for seamless integration with the [SMSGate](https://sms-gate.app) API. Programmatically send SMS messages through your Android devices with strict typing and modern JavaScript features.
1111

1212
**Note**: The API doesn't provide CORS headers, so the library cannot be used in a browser environment directly.
1313

@@ -130,7 +130,7 @@ async function generateJWTToken() {
130130
async function initializeJWTClient() {
131131
const jwtToken = await generateJWTToken();
132132

133-
// Initialize client with JWT token (empty string for login, token for passwordOrToken)
133+
// Initialize client with JWT token (empty string for login, token for password)
134134
const jwtClient = new Client(
135135
"", // Empty string for login when using JWT
136136
jwtToken // JWT token
@@ -277,12 +277,12 @@ api.patchSettings(partialSettings)
277277

278278
The `Client` class accepts the following constructor arguments:
279279

280-
| Argument | Description | Default |
281-
| ----------------- | -------------------------- | ---------------------------------------- |
282-
| `login` | Username or empty string | **Required** |
283-
| `passwordOrToken` | Password or JWT token | **Required** |
284-
| `httpClient` | HTTP client implementation | **Required** |
285-
| `baseUrl` | API base URL | `"https://api.sms-gate.app/3rdparty/v1"` |
280+
| Argument | Description | Default |
281+
| ------------ | -------------------------- | ---------------------------------------- |
282+
| `login` | Username or empty string | **Required** |
283+
| `password` | Password or JWT token | **Required** |
284+
| `httpClient` | HTTP client implementation | `fetch` |
285+
| `baseUrl` | API base URL | `"https://api.sms-gate.app/3rdparty/v1"` |
286286

287287
#### Authentication Configuration
288288

0 commit comments

Comments
 (0)