From 2972ce1afa11672416531a3d217093a3d1d7e607 Mon Sep 17 00:00:00 2001 From: bendrucker Date: Mon, 12 Jan 2026 19:17:19 -0800 Subject: [PATCH 1/2] Add Why section to README Explain the plugin's value proposition for power users working across many repositories and in large monorepos where symlinking is impractical. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index d935cf9..1a92ee0 100644 --- a/README.md +++ b/README.md @@ -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 ideal for power 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 impractical. + +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) From 44200085aa87ae80c6111901bc4e368d18886cfd Mon Sep 17 00:00:00 2001 From: Ben Drucker Date: Mon, 12 Jan 2026 19:35:52 -0800 Subject: [PATCH 2/2] Update README with clearer plugin usage instructions Clarified the use case for the plugin and improved the explanation of symlinking `AGENTS.md` to `CLAUDE.md`. Enhanced the description of the plugin's functionality and adherence to the `AGENTS.md` spec. --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1a92ee0..1745fb8 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,18 @@ Loads project instructions from `AGENTS.md` files automatically, enabling Claude ## Why -This plugin is ideal for power 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 impractical. +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)