Skip to content

Fix README inaccuracies: install instructions, example output, worktree paths #36

@that-github-user

Description

@that-github-user

Summary

Several inaccuracies in README found during audit:

  1. Install instructionsnpm install -g thinktank won't work because dist/ isn't built during install (see Add npm publish workflow and prepublish build step #28)
  2. Next steps section — shows git diff --no-index /dev/null <worktree>/... which is wrong. Should be cd <worktree> && git diff HEAD
  3. Example output — shows worktree paths as generic placeholders. Should show actual paths or note they're in system temp directory
  4. Model flag--model opus shown but no docs on valid model names

Acceptance criteria

  • Install instructions accurate (or marked as "from source" until npm publish works)
  • Worktree inspection instructions are correct
  • Model names documented
  • Example output matches actual CLI output format

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions