Browse Source

docs: Update installation instructions

- Fix plugin install command (direct GitHub, no marketplace)
- Add Rules to manual install directories
- Update AGENTS.md with new directories and key resources
- Update skill count to 11 (includes tool-discovery)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
0xDarkMatter 4 months ago
parent
commit
395d91b356
2 changed files with 36 additions and 11 deletions
  1. 32 9
      AGENTS.md
  2. 4 2
      README.md

+ 32 - 9
AGENTS.md

@@ -5,20 +5,33 @@
 This is **claude-mods** - a collection of custom extensions for Claude Code:
 - **24 expert agents** for specialized domains (React, Python, AWS, etc.)
 - **11 slash commands** for workflows (/sync, /plan, /review, etc.)
-- **10 skills** for CLI tool integration (git-workflow, code-stats, etc.)
+- **11 skills** for CLI tool integration (git-workflow, code-stats, tool-discovery, etc.)
+
+## Installation
+
+```bash
+# Plugin install (recommended)
+/plugin install 0xDarkMatter/claude-mods
+
+# Or clone and run install script
+git clone https://github.com/0xDarkMatter/claude-mods.git
+cd claude-mods && ./scripts/install.sh  # or .\scripts\install.ps1 on Windows
+```
 
 ## Key Directories
 
 | Directory | Purpose |
 |-----------|---------|
+| `.claude-plugin/` | Plugin metadata (plugin.json) |
 | `agents/` | Expert subagent prompts (.md files) |
 | `commands/` | Slash command definitions |
 | `skills/` | Skill definitions with SKILL.md |
-| `rules/` | Claude Code rules (cli-tools.md) |
+| `hooks/` | Hook examples (pre/post execution) |
+| `rules/` | Claude Code rules (cli-tools.md, thinking.md) |
 | `tools/` | Modern CLI toolkit documentation |
 | `tests/` | Validation scripts + justfile |
 | `scripts/` | Install scripts |
-| `docs/` | PLAN.md, DASH.md |
+| `docs/` | PLAN.md, DASH.md, WORKFLOWS.md |
 
 ## Session Init
 
@@ -26,16 +39,26 @@ On "INIT:" message at session start:
 1. Read the specified file (.claude/.context-init.md)
 2. Proceed with user request - no summary needed
 
-## CLI Tool Preferences
+## Key Resources
+
+| Resource | Description |
+|----------|-------------|
+| `rules/cli-tools.md` | Modern CLI tool preferences (rg, fd, eza, bat) |
+| `rules/thinking.md` | Extended thinking triggers (think → ultrathink) |
+| `docs/WORKFLOWS.md` | 10 workflow patterns from Anthropic best practices |
+| `skills/tool-discovery/` | Find the right library for any task |
+| `hooks/README.md` | Pre/post execution hook examples |
+
+## Quick Reference
+
+**CLI Tools:** Use `rg` over grep, `fd` over find, `eza` over ls, `bat` over cat
+
+**Web Fetching:** WebFetch → Jina (`r.jina.ai/`) → `firecrawl` → firecrawl-expert agent
 
-See `rules/cli-tools.md` for modern CLI tool preferences:
-- Use `rg` over grep, `fd` over find, `eza` over ls
-- Use `bat` over cat, `dust` over du, `tldr` over man
-- Web fetching: WebFetch → Jina → firecrawl → firecrawl-expert
+**Extended Thinking:** "think" < "think hard" < "think harder" < "ultrathink"
 
 ## Testing
 
-Run from `tests/` directory:
 ```bash
 cd tests && just test
 ```

+ 4 - 2
README.md

@@ -25,10 +25,11 @@ claude-mods/
 
 ```bash
 # In Claude Code, run:
-/plugin marketplace add 0xDarkMatter/claude-mods
-/plugin install claude-mods
+/plugin install 0xDarkMatter/claude-mods
 ```
 
+This installs directly from GitHub. Toggle on/off with `/plugin` menu.
+
 ### Script Install
 
 **Linux/macOS:**
@@ -55,6 +56,7 @@ Then symlink or copy to your Claude directories:
 - Commands → `~/.claude/commands/`
 - Skills → `~/.claude/skills/`
 - Agents → `~/.claude/agents/`
+- Rules → `~/.claude/rules/`
 
 ## What's Included