Skip to content

Commit 284b446

Browse files
authored
Merge pull request #65 from JJ-Cro/llmstxt
chore(v1.2.4): add llms.txt, update tsconfig, bump dependencies, update readme
2 parents 1c3badb + ca63916 commit 284b446

File tree

6 files changed

+11687
-10
lines changed

6 files changed

+11687
-10
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ bundleReport.html
2424
dist
2525
coverage
2626
localtest.sh
27+
repomix.sh
2728

2829
ws-private-spot-wsapi-performance.ts
2930
ws-private-perp-futures-wsapi-readonly.ts

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -375,6 +375,12 @@ DefaultLogger.silly = () => {};
375375
const ws = new WebsocketClient({ key: 'xxx', secret: 'yyy' }, DefaultLogger);
376376
```
377377

378+
## Use with LLMs & AI
379+
380+
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.
381+
382+
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.
383+
378384
---
379385

380386
<!-- template_contributions -->

0 commit comments

Comments
 (0)