Skip to content

Commit ff79a21

Browse files
committed
chore: adjust setup command
chore: wip chore: wip chore: wip
1 parent 730aba5 commit ff79a21

File tree

11 files changed

+1653
-489
lines changed

11 files changed

+1653
-489
lines changed

README.md

Lines changed: 40 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ A modern, fast alternative to Dependabot and Renovate built for the JavaScript a
3535
bun add -g buddy-bot
3636

3737
# Interactive setup (recommended)
38-
bunx buddy-bot setup
38+
buddy-bot setup
3939

40-
# Or run directly
41-
bunx buddy-bot scan
40+
# Or run directly for scanning only
41+
buddy-bot scan
4242
```
4343

4444
## Usage
@@ -51,16 +51,45 @@ The easiest way to get started is with the interactive setup command:
5151
buddy-bot setup
5252
```
5353

54-
This will guide you through creating GitHub Actions workflows for automated dependency updates. Choose from several presets:
54+
This comprehensive setup wizard will guide you through configuring automated dependency updates for your project in a Renovate-like experience. The setup process includes:
55+
56+
**🔍 Step 1: Repository Detection**
57+
- Automatically detects your GitHub repository from git remote
58+
- Validates repository access and configuration
59+
60+
**🔑 Step 2: GitHub Token Setup**
61+
- Guides you through creating a Personal Access Token (PAT)
62+
- Explains required scopes (`repo`, `workflow`) for full functionality
63+
- Helps set up repository secrets for enhanced features
64+
65+
**🔧 Step 3: Repository Settings**
66+
- Walks you through GitHub Actions permissions configuration
67+
- Ensures proper workflow permissions for PR creation
68+
69+
**⚙️ Step 4: Workflow Configuration**
70+
Choose from several carefully crafted presets:
5571

56-
- **Standard Project** - Daily patch updates, weekly minor updates, monthly major updates
57-
- **High Frequency Updates** - Check for updates 4 times per day _(6AM, 12PM, 6PM, 12AM)_
72+
- **Standard Setup (Recommended)** - Dashboard updates 3x/week, balanced dependency updates
73+
- **High Frequency** - Check for updates multiple times per day
5874
- **Security Focused** - Frequent patch updates with security-first approach
59-
- **Minimal Updates** - Weekly patch updates, monthly minor/major updates
60-
- **Docker Project** - Optimized for containerized applications
61-
- **Monorepo** - Multiple packages in a single repository
62-
- **Development/Testing** - Manual trigger + every 5 minutes _(perfect for testing)_
63-
- **Custom Configuration** - Create your own update schedule
75+
- **Minimal Updates** - Weekly checks, lower frequency
76+
- **Development/Testing** - Manual triggers + frequent checks for testing
77+
- **Custom Configuration** - Create your own schedule
78+
79+
**📝 Step 5: Configuration File Generation**
80+
- Creates `buddy-bot.config.json` with your repository settings
81+
- Includes sensible defaults and customization options
82+
83+
**🔄 Step 6: Workflow Generation**
84+
- Generates three core GitHub Actions workflows:
85+
- `buddy-dashboard.yml` - Dependency Dashboard Management
86+
- `buddy-update-check.yml` - Auto-rebase PR checker
87+
- `buddy-update.yml` - Scheduled dependency updates
88+
89+
**🎯 Step 7: Final Instructions**
90+
- Provides clear next steps with git commands
91+
- Links to GitHub settings pages for easy configuration
92+
- Explains token setup and repository permissions
6493

6594
### Command Line Interface
6695

0 commit comments

Comments
 (0)