Skip to content

Commit cf30133

Browse files
authored
Merge pull request #685 from sieblyio/links31aug1
feat(v3.6.4): link package docs to Siebly pages
2 parents 9eeb2c7 + b2af711 commit cf30133

5 files changed

Lines changed: 115 additions & 105 deletions

File tree

.npmrc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
min-release-age=30
2+
save-exact=true

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -602,7 +602,7 @@ const wsClient = new WebsocketAPIClient({
602602
});
603603

604604
// Optional, if you see RECV Window errors, you can use this to manage time issues. However, make sure you sync your system clock first!
605-
// https://github.com/tiagosiebler/awesome-crypto-examples/wiki/Timestamp-for-this-request-is-outside-of-the-recvWindow
605+
// https://github.com/sieblyio/awesome-crypto-examples/wiki/Timestamp-for-this-request-is-outside-of-the-recvWindow
606606
// wsClient.setTimeOffsetMs(-5000);
607607

608608
// Optional, see above. Can be used to prepare a connection before sending commands

docs/BINANCE_SDK_QUICKSTART_GUIDE.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -65,22 +65,22 @@ siebly:
6565
packageNodes:
6666
- label: MainClient
6767
summary: Spot, margin, wallet, earn, sub-accounts
68-
href: https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts
68+
href: https://github.com/sieblyio/binance/blob/master/src/main-client.ts
6969
- label: USDMClient
7070
summary: USD-M Futures REST API
71-
href: https://github.com/tiagosiebler/binance/blob/master/src/usdm-client.ts
71+
href: https://github.com/sieblyio/binance/blob/master/src/usdm-client.ts
7272
- label: CoinMClient
7373
summary: COIN-M Futures REST API
74-
href: https://github.com/tiagosiebler/binance/blob/master/src/coinm-client.ts
74+
href: https://github.com/sieblyio/binance/blob/master/src/coinm-client.ts
7575
- label: PortfolioClient
7676
summary: Portfolio Margin REST API
77-
href: https://github.com/tiagosiebler/binance/blob/master/src/portfolio-client.ts
77+
href: https://github.com/sieblyio/binance/blob/master/src/portfolio-client.ts
7878
- label: WebsocketClient
7979
summary: Public streams and listen-key user data
80-
href: https://github.com/tiagosiebler/binance/blob/master/src/websocket-client.ts
80+
href: https://github.com/sieblyio/binance/blob/master/src/websocket-client.ts
8181
- label: WebsocketAPIClient
8282
summary: Awaitable WebSocket API commands
83-
href: https://github.com/tiagosiebler/binance/blob/master/src/websocket-api-client.ts
83+
href: https://github.com/sieblyio/binance/blob/master/src/websocket-api-client.ts
8484
coverage:
8585
heading: Start with the right Binance API client
8686
summary: The guide starts with public calls, then moves into private account streams, trading commands, environments, proxy configuration, reconnects, and the checks you need before production.
@@ -203,7 +203,7 @@ siebly:
203203
href: /examples/Binance/WebSockets/WS-API/ws-api-client
204204
- heading: Source repository
205205
summary: Browse SDK source, releases, issues, and endpoint coverage from GitHub.
206-
href: https://github.com/tiagosiebler/binance
206+
href: https://github.com/sieblyio/binance
207207
-->
208208
# Binance SDK Quickstart Guide
209209

@@ -219,7 +219,7 @@ The SDK handles request building and connectivity for you, including request sig
219219
**Key links**
220220

221221
- Binance JavaScript SDK by Siebly: [`binance`](https://www.npmjs.com/package/binance)
222-
- GitHub Repository: [`tiagosiebler/binance`](https://github.com/tiagosiebler/binance)
222+
- GitHub Repository: [`sieblyio/binance`](https://github.com/sieblyio/binance)
223223
- SDK function-endpoint map: [Binance JavaScript Endpoint Reference](./endpointFunctionList.md)
224224
- REST API examples: [Binance SDK REST API examples](../examples/Rest/Spot/rest-spot-public.ts)
225225
- WebSocket examples: [Binance SDK WebSocket examples](../examples/WebSockets/Public/ws-public.ts)
@@ -248,7 +248,7 @@ Most of that work is handled for you, while the grouping & naming stays close to
248248
<!-- siebly:section id="install-and-api-keys" -->
249249
## Install and API keys
250250

251-
If you do not have Node.js installed yet, install it first. The SDK is published to both [GitHub](https://github.com/tiagosiebler/binance) and [npm](https://www.npmjs.com/package/binance), and can therefore be installed with your favourite Node.js compatible package manager.
251+
If you do not have Node.js installed yet, install it first. The SDK is published to both [GitHub](https://github.com/sieblyio/binance) and [npm](https://www.npmjs.com/package/binance), and can therefore be installed with your favourite Node.js compatible package manager.
252252

253253
Install the SDK with npm:
254254

@@ -1317,7 +1317,7 @@ For margin, the SDK handles the listen-token workflow used by Binance's margin W
13171317

13181318
### Futures user data streams with `WebsocketClient`
13191319

1320-
Futures user data streams are conveniently available through `WebsocketClient` in the [Binance JavaScript SDK](/sdk/binance/javascript). Both USD-M and COIN-M Futures user data streams on Binance follow a listenKey mechanic. The SDK automates the life cycle and maintenance of this listenKey for you. Request the subscription and handle incoming events, as shown in the following example:
1320+
Futures user data streams are conveniently available through `WebsocketClient` in the [Binance JavaScript SDK](https://siebly.io/sdk/binance/javascript). Both USD-M and COIN-M Futures user data streams on Binance follow a listenKey mechanic. The SDK automates the life cycle and maintenance of this listenKey for you. Request the subscription and handle incoming events, as shown in the following example:
13211321

13221322
```typescript
13231323
import { WebsocketClient } from 'binance';
@@ -1924,7 +1924,7 @@ No. This guide covers the common first steps and production concerns. For full m
19241924

19251925
- [Binance JavaScript endpoint reference](./endpointFunctionList.md)
19261926
- [Binance SDK examples](../examples)
1927-
- [Binance SDK source on GitHub](https://github.com/tiagosiebler/binance)
1927+
- [Binance SDK source on GitHub](https://github.com/sieblyio/binance)
19281928

19291929
---
19301930

@@ -1936,6 +1936,6 @@ If you want to learn more about integrating with Binance APIs and WebSockets:
19361936
- Explore the [Binance JavaScript examples on GitHub](../examples)
19371937
- Review the full endpoint list: [Binance JavaScript endpoint reference](./endpointFunctionList.md)
19381938
- Check the Binance JavaScript SDK on npm: [`binance`](https://www.npmjs.com/package/binance)
1939-
- Browse the source code of the Binance JavaScript SDK on GitHub: [`tiagosiebler/binance`](https://github.com/tiagosiebler/binance)
1939+
- Browse the source code of the Binance JavaScript SDK on GitHub: [`sieblyio/binance`](https://github.com/sieblyio/binance)
19401940
- Review auth examples: [Ed25519](../examples/auth/rest-private-ed25519.md) and [RSA](../examples/auth/rest-private-rsa.md)
19411941
- Explore the wider SDK ecosystem: [Siebly.io](https://siebly.io)

0 commit comments

Comments
 (0)