From 6b5d3c6c5b929ee15c9a5dd0b8ec59f73b937950 Mon Sep 17 00:00:00 2001
From: Dean Sharon <deanshrn@gmain.com>
Date: Wed, 25 Feb 2026 16:58:38 +0200
Subject: [PATCH] fix: move CODEOWNERS to .github/ and add skimmer README
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Move CODEOWNERS to GitHub's recommended .github/ location so it's
properly detected after subtree sync to dean0x/skimmer.

Add README.md for the standalone skimmer repo with install instructions,
usage examples, and structured report documentation.

Disable issues on dean0x/skimmer (mirror repo — issues belong on
dean0x/skim) and add tree-sitter, llm, context-optimization topics.
---
 plugins/skimmer/{ => .github}/CODEOWNERS |  0
 plugins/skimmer/README.md                | 73 ++++++++++++++++++++++++
 2 files changed, 73 insertions(+)
 rename plugins/skimmer/{ => .github}/CODEOWNERS (100%)
 create mode 100644 plugins/skimmer/README.md

diff --git a/plugins/skimmer/CODEOWNERS b/plugins/skimmer/.github/CODEOWNERS
similarity index 100%
rename from plugins/skimmer/CODEOWNERS
rename to plugins/skimmer/.github/CODEOWNERS
diff --git a/plugins/skimmer/README.md b/plugins/skimmer/README.md
new file mode 100644
index 0000000..95c15a8
--- /dev/null
+++ b/plugins/skimmer/README.md
@@ -0,0 +1,73 @@
+# Skimmer
+
+Codebase orientation agent for [Claude Code](https://docs.anthropic.com/en/docs/claude-code) — powered by [rskim](https://github.com/dean0x/skim).
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+## What it does
+
+Skimmer is a Claude Code plugin that orients you in unfamiliar codebases. It uses `rskim` (tree-sitter) to extract code structure without implementation noise, then searches for task-relevant files and patterns. The result is a structured orientation report: project type, directory layout, relevant files, key functions, integration points, and a suggested approach.
+
+## Install
+
+```
+/plugin marketplace add dean0x/skimmer
+```
+
+## Usage
+
+```
+# Orient for a specific task
+/skim add JWT authentication
+
+# General codebase orientation
+/skim
+```
+
+**With a task description**, Skimmer focuses its search on files, functions, and patterns relevant to that task and suggests where to integrate.
+
+**Without arguments**, it produces a general orientation: project type, directory structure, key modules, and entry points.
+
+## What you get
+
+Skimmer generates a structured report:
+
+| Section | Content |
+|---------|---------|
+| **Project Type** | Language, framework, dependencies |
+| **Token Statistics** | Original vs skimmed token counts |
+| **Directory Structure** | Source directories and their purpose |
+| **Relevant Files** | Files matching the task with key exports |
+| **Key Functions/Types** | Specific signatures related to the task |
+| **Integration Points** | Where new code connects to existing code |
+| **Patterns Observed** | Existing conventions to follow |
+| **Suggested Approach** | Recommendation based on codebase structure |
+
+## How it works
+
+1. **Detect project type** from manifest files (`package.json`, `Cargo.toml`, etc.)
+2. **Map source directories** and skim them with `rskim --mode structure`
+3. **Search for task-relevant code** using Grep/Glob, then skim matches with `--mode signatures`
+4. **Identify integration points** — entry points, public exports, configuration patterns
+5. **Generate the orientation report**
+
+If `rskim` isn't available, the agent falls back to manual exploration using Glob, Grep, and Read.
+
+## Requirements
+
+`rskim` is invoked via `npx rskim` (auto-downloads if not installed). Alternatives:
+
+- **npm** (global): `npm install -g rskim`
+- **Cargo**: `cargo install rskim`
+
+No configuration needed — the agent handles tool detection and fallback automatically.
+
+## Links
+
+- [skim](https://github.com/dean0x/skim) — main project (issues, contributions, full documentation)
+- [rskim on npm](https://www.npmjs.com/package/rskim)
+- [rskim on crates.io](https://crates.io/crates/rskim)
+
+## License
+
+[MIT](LICENSE)