Skip to content

Commit bd91756

Browse files
authored
docs(readme): correct npm install scope to @sf-agentscript (#34)
The Quick Start showed `pnpm add @agentscript/agentforce`, but scripts/publish.mjs rewrites @agentscript/* to @sf-agentscript/* at publish time, so the documented name is not on npm. Updates the install command and import example to the published scope and adds a one-line note linking to publish.mjs so future readers understand the internal-vs-published name distinction. Fixes #6
1 parent 4fcffbe commit bd91756

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,12 +71,14 @@ Opens the AgentScript playground at `http://localhost:27002`.
7171

7272
### Use as a Library
7373

74+
> Packages are published to npm under the `@sf-agentscript/*` scope. The `@agentscript/*` names used elsewhere in this repo are the internal monorepo names — see [`scripts/publish.mjs`](scripts/publish.mjs).
75+
7476
```bash
75-
pnpm add @agentscript/agentforce
77+
pnpm add @sf-agentscript/agentforce
7678
```
7779

7880
```typescript
79-
import { parse } from '@agentscript/agentforce';
81+
import { parse } from '@sf-agentscript/agentforce';
8082

8183
const doc = parse(`
8284
system:

0 commit comments

Comments
 (0)