Skip to content

Commit 1220416

Browse files
committed
feat: update-readme-installation - npm installation instructions
1 parent a0b6bad commit 1220416

3 files changed

Lines changed: 21 additions & 2 deletions

File tree

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,19 @@ The harness consists of a simple for-loop, executing a new coding agent with a m
1616

1717
## Installation
1818

19+
### From npm (recommended)
20+
21+
```bash
22+
# One-off usage (recommended)
23+
bunx @cephalization/math <command>
24+
25+
# Global install
26+
bun install -g @cephalization/math
27+
```
28+
29+
### From source (for development)
30+
1931
```bash
20-
# Clone and link globally
2132
git clone https://github.com/cephalization/math.git
2233
cd math
2334
bun install

todo/LEARNINGS.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,11 @@ Use this knowledge to avoid repeating mistakes and build on what works.
5555
- The workflow triggers on both `push` to main and all `pull_request` events (any branch)
5656
- Steps are sequential (typecheck then test) since we want to fail fast on type errors before running tests
5757
- Pre-existing test failure (1 fail, 86 pass) still present - the "dry-run mode skips git operations" test expects a "Skipping git branch creation" message that isn't being logged
58+
59+
## update-readme-installation
60+
61+
- Split the Installation section into "From npm (recommended)" and "From source (for development)" subsections
62+
- Put npm installation first since most users will want to install from npm, not clone the repo
63+
- Kept `bunx` as the recommended method for one-off usage since it doesn't require global installation
64+
- Documentation-only changes don't require tests - verified existing tests still pass (with same pre-existing failure)
65+
- Pre-existing test failure (1 fail, 86 pass) confirmed to exist before changes via git stash verification

todo/TASKS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Each agent picks the next pending task, implements it, and marks it complete.
6969
### update-readme-installation
7070

7171
- content: Update README.md installation section to show npm installation methods: 1) `bunx @cephalization/math <command>` (recommended for one-off usage), 2) `bun install -g @cephalization/math` (global install). Keep the existing clone/link instructions for development.
72-
- status: pending
72+
- status: complete
7373
- dependencies: update-package-name
7474

7575
### update-readme-bun-requirement

0 commit comments

Comments
 (0)