diff --git a/.changeset/bumpy-rockets-help.md b/.changeset/bumpy-rockets-help.md new file mode 100644 index 0000000..54bea2c --- /dev/null +++ b/.changeset/bumpy-rockets-help.md @@ -0,0 +1,5 @@ +--- +"@cephalization/math": patch +--- + +docs: Update README diff --git a/README.md b/README.md index 3e7cc57..816cd97 100644 --- a/README.md +++ b/README.md @@ -24,9 +24,22 @@ curl -fsSL https://bun.sh/install | bash ``` Why Bun? + - This tool is written in TypeScript and uses Bun's native TypeScript execution (no compilation step) - The CLI uses a `#!/usr/bin/env bun` shebang for direct execution -- Bun's speed makes the agent loop faster and more responsive + + +**[OpenCode](https://opencode.ai) is required** to run this tool. + +```bash +# Install OpenCode +curl -fsSL https://opencode.ai/install | bash +``` + +Why OpenCode? + +- OpenCode provides a consistent and reliable interface for running the agent loop +- It supports many models, is easy to use, and is free to use ## Installation @@ -94,6 +107,15 @@ Options: - `--max-iterations ` - Safety limit (default: 100) - `--pause ` - Pause between iterations (default: 3) +Iteratively run the agent loop until all tasks are complete. Each iteration will: + +- Read the `TASKS.md` file to find the next task to complete +- Invoke the agent with the `PROMPT.md` file and the `TASKS.md` file +- The agent will complete the task and update the `TASKS.md` file +- The agent will log its learnings to the `LEARNINGS.md` file +- The agent will commit the changes to the repository +- The agent will exit + ### Check status ```bash @@ -178,7 +200,7 @@ Signs accumulate over time, making the agent increasingly reliable. | Variable | Default | Description | |----------|---------|-------------| -| `MODEL` | `anthropic/claude-opus-4-20250514` | Model to use | +| `MODEL` | `anthropic/claude-opus-4-5` | Model to use | ## Credits