Skip to content

fix: ship the docs that the package README links to #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Karnaukhov-kh merged 1 commit into from
Oct 20, 2026
Merged

fix: ship the docs that the package README links to #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/iterward/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ Iterward needs Node.js 22.18 or later and has no npm dependencies. Install it as
npm install --save-dev @push-based/iterward
```

The package gives you the `iterward` command, which you run as `npx iterward`, the engine, which a test imports from `@push-based/iterward`, the MCP server, the default loop, and the build-loop skill. To work on Iterward itself, see the [repository README](../../README.md).
The package gives you the `iterward` command, which you run as `npx iterward`, the engine, which a test imports from `@push-based/iterward`, the MCP server, the default loop, and the build-loop skill. To work on Iterward itself, see the [repository README](https://github.com/push-based/iterward#readme).

To try Iterward without an install, run each command as `npx @push-based/iterward`, such as `npx @push-based/iterward init`. An install pins the version your runs use, and lets a test import the engine.

Expand Down
2 changes: 1 addition & 1 deletion packages/iterward/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"type": "module",
"exports": { ".": { "types": "./dist/engine.d.ts", "default": "./dist/engine.js" } },
"bin": { "iterward": "./dist/bin.js" },
"files": ["dist", "examples", "skills", "!skills/*/evals"],
"files": ["dist", "docs", "examples", "skills", "!skills/*/evals"],
"engines": { "node": ">=22.18" },
"repository": { "type": "git", "url": "git+https://github.com/push-based/iterward.git", "directory": "packages/iterward" },
"publishConfig": { "access": "public" },
Expand Down
Loading