bitget-api 3.0.0 → 3.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -3
- package/llms.txt +14190 -0
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -127,9 +127,9 @@ import { RestClientV3 } from 'bitget-api';
|
|
|
127
127
|
|
|
128
128
|
// note the single quotes, preventing special characters such as $ from being incorrectly passed
|
|
129
129
|
const client = new RestClientV3({
|
|
130
|
-
apiKey: process.env.API_KEY_COM ||
|
|
131
|
-
apiSecret: process.env.API_SECRET_COM ||
|
|
132
|
-
apiPass: process.env.API_PASS_COM ||
|
|
130
|
+
apiKey: process.env.API_KEY_COM || 'insert_api_key_here',
|
|
131
|
+
apiSecret: process.env.API_SECRET_COM || 'insert_api_secret_here',
|
|
132
|
+
apiPass: process.env.API_PASS_COM || 'insert_api_pass_here',
|
|
133
133
|
});
|
|
134
134
|
|
|
135
135
|
(async () => {
|
|
@@ -480,6 +480,12 @@ Build a bundle using webpack:
|
|
|
480
480
|
|
|
481
481
|
The bundle can be found in `dist/`. Altough usage should be largely consistent, smaller differences will exist. Documentation is still TODO - contributions welcome.
|
|
482
482
|
|
|
483
|
+
## Use with LLMs & AI
|
|
484
|
+
|
|
485
|
+
This SDK includes a bundled `llms.txt` file in the root of the repository. If you're developing with LLMs, use the included `llms.txt` with your LLM - it will significantly improve the LLMs understanding of how to correctly use this SDK.
|
|
486
|
+
|
|
487
|
+
This file contains AI optimised structure of all the functions in this package, and their parameters for easier use with any learning models or artificial intelligence.
|
|
488
|
+
|
|
483
489
|
---
|
|
484
490
|
|
|
485
491
|
<!-- template_contributions -->
|