diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..5bf2d64 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,25 @@ +cff-version: 1.2.0 +message: "If you use this guide, please cite it as below." +type: dataset +title: "Claude Code Ultimate Guide" +abstract: "Comprehensive community guide for Claude Code (Anthropic's CLI tool). 9,600+ lines of documentation, 87 production-ready templates, 159-question quiz." +authors: + - family-names: "Bruniaux" + given-names: "Florian" + affiliation: "MΓ©thode Aristote" +version: "3.8.0" +date-released: "2026-01-16" +license: "CC-BY-SA-4.0" +url: "https://github.com/FlorianBruniaux/claude-code-ultimate-guide" +repository-code: "https://github.com/FlorianBruniaux/claude-code-ultimate-guide" +keywords: + - claude-code + - anthropic + - ai-coding + - developer-tools + - ai-assistant + - prompt-engineering + - mcp-servers + - productivity + - cli-tool + - llm diff --git a/README.md b/README.md index 55a8c5d..8283b5c 100644 --- a/README.md +++ b/README.md @@ -163,15 +163,21 @@ curl -sL https://raw.githubusercontent.com/FlorianBruniaux/claude-code-ultimate- **Want deeper analysis?** Use [`tools/audit-prompt.md`](./tools/audit-prompt.md) for personalized recommendations (~3 min). -### πŸ€– LLM Reference +### πŸ€– For AI Assistants -Give any AI assistant instant Claude Code expertise (~2K tokens): +This guide is optimized for both human and AI consumption: +| Resource | Purpose | Tokens | +|----------|---------|--------| +| **[llms.txt](./machine-readable/llms.txt)** | Standard context file for AI crawlers | ~1K | +| **[reference.yaml](./machine-readable/reference.yaml)** | Structured index with line numbers | ~2K | + +**Quick load** (paste in any AI assistant): ```bash curl -sL https://raw.githubusercontent.com/FlorianBruniaux/claude-code-ultimate-guide/main/machine-readable/reference.yaml ``` -**Use cases**: Paste output into ChatGPT/Claude/Gemini, add to system prompts, or reference in Claude Code with `@machine-readable/reference.yaml` +**Use cases**: Inject into ChatGPT/Claude/Gemini, add to system prompts, reference in Claude Code with `@machine-readable/reference.yaml` **What's inside**: Decision trees, command reference, context zones, MCP servers, agent templates, troubleshootingβ€”optimized for machine consumption. Points to line numbers in the [full guide](./guide/ultimate-guide.md) for deep dives. @@ -431,7 +437,8 @@ claude-code-ultimate-guide/ β”‚ β”œβ”€β”€ tdd-with-claude.md β”‚ β”œβ”€β”€ spec-first.md β”‚ β”œβ”€β”€ plan-driven.md -β”‚ └── iterative-refinement.md +β”‚ β”œβ”€β”€ iterative-refinement.md +β”‚ └── pdf-generation.md β”‚ β”œβ”€β”€ tools/ # πŸ”§ Interactive utilities β”‚ β”œβ”€β”€ audit-prompt.md # Setup audit with recommendations @@ -517,7 +524,7 @@ Copy-paste templates from [`examples/`](./examples/) for immediate use: | [claude-security-review.yml](./examples/github-actions/claude-security-review.yml) | PR open | Security scan (OWASP Top 10) | | [claude-issue-triage.yml](./examples/github-actions/claude-issue-triage.yml) | Issue opened | Auto-triage with labels | -**[See Complete Catalog](./examples/README.md)** β€” Includes agents, skills, memory templates, config files, workflows +**[See Complete Catalog](./examples/README.md)** | **[Browse Interactive Catalog](./examples/index.html)** β€” Includes agents, skills, memory templates, config files, workflows --- @@ -652,7 +659,15 @@ If this guide saved you time, helped you master Claude Code, or inspired your wo --- -*Version 3.7.1 | January 2026 | Crafted with Claude* +## πŸ“¬ Stay Updated + +Get notified about major updates, new templates, and Claude Code best practices: + +**[Subscribe to the newsletter](https://buttondown.com/claude-code-guide)** β€” No spam, 1-2 emails/month max, unsubscribe anytime. + +--- + +*Version 3.8.0 | January 2026 | Crafted with Claude*