Skip to content

readme: add Why section #7

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
bendrucker merged 2 commits into from
Jan 13, 2026
Merged

readme: add Why section #7

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
4420008
Update README with clearer plugin usage instructions
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
14 changes: 14 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,20 @@

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

## Why

If you work in a small number of repositories, symlinking `AGENTS.md` to `CLAUDE.md` is probably fine:

```sh
ln -s AGENTS.md CLAUDE.md
```

This plugin is intended for users who work across many repositories and want consistent `AGENTS.md` support without per-project setup. It's also useful for large monorepos where linking `AGENTS.md` to `CLAUDE.md` in every subdirectory is harder to reliably maintain.

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.

This plug-in tries to adhere as closely as possible to the `AGENTS.md` spec, which has [subtle differences from `CLAUDE.md`](#agentsmd-vs-claudemd).

## Requirements

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