Skip to content

Commit 405ccac

Browse files
committed
feat: update README with NPM registry configuration for @badaitech packages
1 parent 3affbd6 commit 405ccac

1 file changed

Lines changed: 18 additions & 8 deletions

File tree

packages/badai-api-example/README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,24 @@ The BadAI API provides a powerful GraphQL-based interface for creating conversat
3535

3636
## Installation
3737

38+
### Important: NPM Registry Configuration
39+
40+
The `@badaitech` packages are hosted on GitHub Package Registry. You need to configure npm to use the correct registry for `@badaitech` scoped packages.
41+
42+
Create or update your `.npmrc` file in your project root:
43+
44+
```bash
45+
@badaitech:registry=https://npm.pkg.github.com
46+
```
47+
48+
Or configure globally:
49+
50+
```bash
51+
npm config set @badaitech:registry https://npm.pkg.github.com
52+
```
53+
54+
### Install Dependencies
55+
3856
```bash
3957
# Using npm
4058
npm install @badaitech/badai-api graphql graphql-ws viem
@@ -169,17 +187,9 @@ type AgentMeta = {
169187
last_name: string
170188
avatar: string
171189
role: string
172-
llm_config: LLMConfig
173-
template_params: JSON
174190
can_answer: boolean
175191
deployment_status: DeploymentStatus
176192
}
177-
178-
type LLMConfig = {
179-
model: string // e.g., "gpt-4", "claude-3"
180-
temperature: number // 0.0 - 2.0
181-
max_tokens: number // Maximum response length
182-
}
183193
```
184194
185195
### Key Operations

0 commit comments

Comments
 (0)