From 0e73677f96773a3fc860b8227d8a1e35a423e6bc Mon Sep 17 00:00:00 2001 From: Jeremy Eder Date: Fri, 21 Nov 2025 23:43:38 -0500 Subject: [PATCH] docs: add bootstrap quickstart to README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add 'Bootstrap (Recommended)' section as primary Quick Start entry point - Move existing basic usage to 'Assessment Only' subsection - Include 4-line command sequence for copy-paste workflow - Show value prop (what you get in <60 seconds) - Link to detailed tutorial in docs/user-guide.md Fixes #17 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6b29712..8bdea75 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,29 @@ AgentReady evaluates your repository across multiple dimensions of code quality, ## Quick Start +### Bootstrap (Recommended) + +Transform your repository with one command: + +```bash +cd /path/to/your/repo +agentready bootstrap . +git add . && git commit -m "build: Bootstrap agent-ready infrastructure" +git push +``` + +**What you get:** + +- ✅ GitHub Actions workflows (tests, security, AgentReady assessment) +- ✅ Pre-commit hooks (formatters, linters) +- ✅ Issue/PR templates +- ✅ Dependabot configuration +- ✅ Automated assessment on every PR + +**Duration**: <60 seconds + +[See detailed Bootstrap tutorial →](docs/user-guide.md#bootstrap-your-repository) + ### Installation ```bash @@ -30,7 +53,9 @@ source .venv/bin/activate # On Windows: .venv\Scripts\activate pip install -e ".[dev]" ``` -### Basic Usage +### Assessment Only + +For one-time analysis without infrastructure changes: ```bash # Assess current repository