Skip to content

Commit d9a7994

Browse files
authored
Merge pull request #142 from AssemblyAI/5B8DD0B76EF065CD9E44B52CF4273EB0
Sync from internal repo-update ReadMe and add Claude Md file
2 parents 607e203 + a0bd598 commit d9a7994

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,13 @@ The AssemblyAI JavaScript SDK provides an easy-to-use interface for interacting
1616
which supports async and streaming transcription.
1717
It is written primarily for Node.js in TypeScript with all types exported, but also [compatible with other runtimes](./docs/compat.md).
1818

19+
> **⚠️ WARNING**
20+
> This SDK is intended for **testing and light usage only**. It is not recommended for use at scale or with production traffic. For best results, we recommend calling the AssemblyAI API directly via HTTP request. See our [official documentation](https://www.assemblyai.com/docs) for more information, including HTTP code examples.
21+
22+
## Claude Code
23+
24+
This repository includes a [`CLAUDE.md`](CLAUDE.md) file that provides context to Claude Code about this SDK — key APIs, common patterns, and gotchas. When you open this repo in Claude Code, it automatically reads this file to give better assistance.
25+
1926
## Documentation
2027

2128
Visit the [AssemblyAI documentation](https://www.assemblyai.com/docs) for step-by-step instructions and a lot more details about our AI models and API.

0 commit comments

Comments
 (0)