Skip to content

Conversation

@jeremyeder
Copy link
Contributor

Summary

  • 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 proposition (what you get in <60 seconds)
  • Link to detailed tutorial in docs/user-guide.md

Why This Matters

Bootstrap is AgentReady's killer feature - it transforms repos in <60 seconds with GitHub Actions, pre-commit hooks, templates, and automated assessments. But users landing on README.md don't see it. This PR makes bootstrap the default entry point, maximizing adoption.

Changes

Before

  • Quick Start section showed only agentready assess command
  • Bootstrap command buried in docs/user-guide.md

After

  • Quick Start prioritizes Bootstrap (Recommended) first
  • Assessment-only workflow clearly labeled as alternative approach
  • Simple 4-line copy-paste for immediate value

Test Plan

  • Verified markdownlint passes (no new issues introduced)
  • Confirmed link to docs/user-guide.md is correct
  • Reviewed formatting in GitHub markdown preview

Fixes #17

🤖 Generated with Claude Code

- 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 <noreply@anthropic.com>
@jeremyeder jeremyeder merged commit 5b2285b into main Nov 22, 2025
2 of 5 checks passed
@jeremyeder jeremyeder deleted the docs/add-bootstrap-quickstart-readme branch November 22, 2025 04:44
@github-actions
Copy link
Contributor

🎉 This PR is included in version 1.6.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[P0] Add Bootstrap Quickstart to README.md

2 participants