Skip to content

Add Why section to README #5

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

Closed
bendrucker wants to merge 2 commits into from
Closed

Add Why section to README #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2972ce1
Add Why section to README
bendrucker Jan 13, 2026
17768b8
Clarify plugin target audience in README
bendrucker Jan 13, 2026
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
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@

Loads project instructions from `AGENTS.md` files automatically, enabling Claude Code to work with projects using this open standard.

## Why

This plugin is targeted at users who work across many repositories and want consistent `AGENTS.md` support without per-project setup. It's also well-suited for large monorepos where symlinking `AGENTS.md` to `CLAUDE.md` in every subdirectory is less practical.

With the plugin installed, `AGENTS.md` files load automatically as you navigate your codebase. Subdirectory files take precedence over parent files, giving you hierarchical context without manual symlink management.

## Requirements

- Node.js 22.18.0 or later (for native TypeScript support)
Expand Down