Skip to content

Commit 6a071b1

Browse files
committed
feat: Add readme-enhance skill and /github-social:all command
New readme-enhance skill: - Generates shields.io badges based on project analysis - Creates NotebookLM-style infographic prompts - Hybrid style adapts to project type - Direct README.md modification support New commands: - /readme-enhance - Add badges and infographic to README - /github-social:all - Run all skills in sequence Also includes: - Comprehensive reference docs (badge catalog, infographic prompts) - Working examples for different project types - CHANGELOG.md following Keep a Changelog format - Version bump to 0.4.0
1 parent 7b8a4c4 commit 6a071b1

12 files changed

Lines changed: 1852 additions & 3 deletions

File tree

.claude-plugin/plugin.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "github-social",
3-
"version": "0.3.0",
3+
"version": "0.4.0",
44
"description": "Optimize GitHub repository presentation with social preview images and engaging metadata (descriptions, topics)",
55
"author": {
66
"name": "zircote"

CHANGELOG.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
## [0.4.0] - 2025-01-18
11+
12+
### Added
13+
14+
- **[readme-enhance]**: New skill for README enhancement with marketing badges and infographics
15+
- Generates shields.io badges based on project analysis (version, build, license, downloads, language, etc.)
16+
- Creates NotebookLM-style infographic prompts capturing architecture and features
17+
- Hybrid infographic style adapts to project type (CLI, library, framework, app, infrastructure)
18+
- Direct README.md modification with intelligent badge section management
19+
- Comprehensive reference documentation for badge patterns and infographic prompts
20+
- **[/readme-enhance]**: New command to enhance README with badges and infographic
21+
- Supports `--badges-only`, `--infographic-only`, and `--dry-run` flags
22+
- **[/github-social:all]**: New command to run all skills in sequence
23+
- Executes repo-metadata, social-preview, and readme-enhance in order
24+
- Supports `--apply`, `--dry-run`, `--skip-badges`, and `--skip-infographic` flags
25+
- Shared project analysis for efficiency
26+
27+
### Changed
28+
29+
- Updated plugin version to 0.4.0
30+
- Enhanced README documentation with new features and commands
31+
32+
## [0.3.0] - 2025-01-18
33+
34+
### Added
35+
36+
- **[social-preview]**: Added `upload_to_repo` option to automatically upload generated images to GitHub repository
37+
- Uses GitHub MCP tool for seamless integration
38+
- Configurable via `.claude/github-social.local.md`
39+
- **[CI/CD]**: Added GitHub Actions workflow and templates
40+
- Pull request template
41+
- Copilot instructions
42+
43+
### Changed
44+
45+
- Improved social preview skill workflow documentation
46+
47+
## [0.2.0] - 2025-01-18
48+
49+
### Added
50+
51+
- **[repo-metadata]**: New skill for generating optimized repository descriptions and topics
52+
- SEO-friendly descriptions (max 350 chars)
53+
- Topic suggestions for discoverability (max 20 topics)
54+
- Apply changes via `gh` CLI or output for manual review
55+
- **[/repo-metadata]**: New command with `--apply` flag for direct GitHub updates
56+
- GitHub activity badges in README (stars, issues, last commit, PRs welcome)
57+
58+
### Changed
59+
60+
- Updated badge URLs for renamed repository
61+
62+
## [0.1.0] - 2025-01-18
63+
64+
### Added
65+
66+
- **[social-preview]**: Initial skill for generating GitHub social preview images
67+
- Analyzes project files (README, package.json, CLAUDE.md) to understand purpose
68+
- Generates detailed image prompts capturing project spirit
69+
- Supports multiple providers (DALL-E, Stable Diffusion, Midjourney, manual)
70+
- Outputs images meeting GitHub requirements (1280x640px, <1MB)
71+
- **[/social-preview]**: Command to generate social preview images
72+
- **[/github-social:setup]**: Interactive setup wizard for configuration
73+
- Configuration via `.claude/github-social.local.md` with YAML frontmatter
74+
- MIT License
75+
76+
[Unreleased]: https://github.com/zircote/github-social/compare/v0.4.0...HEAD
77+
[0.4.0]: https://github.com/zircote/github-social/compare/v0.3.0...v0.4.0
78+
[0.3.0]: https://github.com/zircote/github-social/compare/v0.2.0...v0.3.0
79+
[0.2.0]: https://github.com/zircote/github-social/compare/v0.1.0...v0.2.0
80+
[0.1.0]: https://github.com/zircote/github-social/releases/tag/v0.1.0

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
44
[![Claude Code Plugin](https://img.shields.io/badge/Claude%20Code-Plugin-blueviolet)](https://claude.ai/claude-code)
5-
[![Version](https://img.shields.io/badge/version-0.2.0-green.svg)](.claude-plugin/plugin.json)
5+
[![Version](https://img.shields.io/badge/version-0.4.0-green.svg)](.claude-plugin/plugin.json)
66
[![GitHub Stars](https://img.shields.io/github/stars/zircote/github-social?style=social)](https://github.com/zircote/github-social)
77
[![GitHub Issues](https://img.shields.io/github/issues/zircote/github-social)](https://github.com/zircote/github-social/issues)
88
[![Last Commit](https://img.shields.io/github/last-commit/zircote/github-social)](https://github.com/zircote/github-social/commits)
@@ -24,6 +24,13 @@ A Claude Code plugin that optimizes GitHub repository presentation by analyzing
2424
- Can apply changes directly via `gh` CLI or output for manual review
2525
- Works with zero configuration
2626

27+
### README Enhancement
28+
- Generates marketing badges (shields.io) based on project analysis
29+
- Creates NotebookLM-style infographic prompts capturing architecture and features
30+
- Supports multiple badge types: version, build, license, downloads, language, and more
31+
- Hybrid infographic style adapts to project type (CLI, library, framework, app)
32+
- Direct README.md modification with intelligent badge section management
33+
2734
## Installation
2835

2936
```bash
@@ -128,13 +135,25 @@ Generates optimized repository descriptions and topics. Triggered by:
128135
- "optimize github metadata"
129136
- "make repo more discoverable"
130137

138+
### readme-enhance
139+
140+
Enhances README with badges and infographics. Triggered by:
141+
- "enhance readme"
142+
- "add badges to readme"
143+
- "create readme infographic"
144+
- "improve readme marketing"
145+
- "add shields.io badges"
146+
- "generate project infographic"
147+
131148
## Commands
132149

133150
| Command | Description |
134151
|---------|-------------|
135152
| `/social-preview` | Generate a social preview image for the current project |
136-
| `/social-preview:setup` | Interactive setup wizard for configuration |
153+
| `/github-social:setup` | Interactive setup wizard for configuration |
137154
| `/repo-metadata` | Generate optimized description and topics (use `--apply` to update GitHub) |
155+
| `/readme-enhance` | Add marketing badges and infographic to README |
156+
| `/github-social:all` | Run all skills in sequence (metadata, social preview, README enhancement) |
138157

139158
## License
140159

commands/all.md

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
---
2+
name: all
3+
description: Run all github-social skills in sequence - metadata, social preview, and README enhancement
4+
argument-hint: "[--apply] [--dry-run] [--skip-badges] [--skip-infographic]"
5+
allowed-tools: ["Read", "Write", "Edit", "Glob", "Grep", "Bash", "MCPSearch"]
6+
---
7+
8+
# Complete GitHub Social Enhancement
9+
10+
Run all github-social skills in sequence to fully optimize a repository's presentation:
11+
12+
1. **repo-metadata**: Generate optimized description and topics
13+
2. **social-preview**: Generate social preview image
14+
3. **readme-enhance**: Add badges and infographic to README
15+
16+
## Execution Steps
17+
18+
### 1. Parse Arguments
19+
20+
Handle optional flags:
21+
- `--apply`: Apply all changes (update GitHub metadata, modify README, upload images)
22+
- `--dry-run`: Preview all changes without applying any
23+
- `--skip-badges`: Skip badge generation in README enhancement
24+
- `--skip-infographic`: Skip infographic generation
25+
26+
Default behavior: Generate and preview, prompt before applying.
27+
28+
### 2. Load Configuration
29+
30+
Read `.claude/github-social.local.md` for all skill settings:
31+
- Social preview provider and style
32+
- Badge style preferences
33+
- Infographic style preferences
34+
- Upload settings
35+
36+
### 3. Analyze Project (Shared)
37+
38+
Perform comprehensive project analysis once, reuse across all skills:
39+
40+
1. Read README.md, package manifest, CLAUDE.md
41+
2. Extract from git remote: owner, repo name, default branch
42+
3. Identify:
43+
- Project name and version
44+
- Purpose and key features
45+
- Primary language and frameworks
46+
- CI/CD configuration
47+
- License type
48+
- Documentation sites
49+
- Community links
50+
51+
### 4. Execute Skills in Sequence
52+
53+
#### Step 4a: Repository Metadata
54+
55+
Generate optimized GitHub metadata:
56+
- Description (max 350 chars, engaging, SEO-friendly)
57+
- Topics (max 20, lowercase, hyphenated)
58+
59+
Output preview of changes.
60+
61+
#### Step 4b: Social Preview Image
62+
63+
Generate social preview:
64+
- Create image prompt based on project analysis
65+
- If provider configured, generate actual image
66+
- Save to configured output path (default: `.github/social-preview.png`)
67+
68+
Output the image prompt (and image location if generated).
69+
70+
#### Step 4c: README Enhancement
71+
72+
Unless `--skip-badges` and `--skip-infographic` both set:
73+
- Generate shields.io badges (unless `--skip-badges`)
74+
- Generate infographic prompt (unless `--skip-infographic`)
75+
- Prepare README.md updates
76+
77+
Output badge set and infographic prompt.
78+
79+
### 5. Present Summary
80+
81+
Display complete summary:
82+
83+
```
84+
## GitHub Social Enhancement Summary
85+
86+
### Repository Metadata
87+
- Description: "..." (X chars)
88+
- Topics: topic-1, topic-2, topic-3, ...
89+
90+
### Social Preview
91+
- Image prompt generated
92+
- Output: .github/social-preview.png
93+
- [Generated/Pending generation]
94+
95+
### README Enhancement
96+
- Badges: X badges generated
97+
- Infographic: Prompt ready
98+
- README changes: [Preview/Applied]
99+
100+
### Next Steps
101+
[Instructions based on --apply flag]
102+
```
103+
104+
### 6. Apply Changes (if --apply or confirmed)
105+
106+
If `--apply` flag or user confirms:
107+
108+
1. **Update GitHub metadata** (via gh CLI):
109+
```bash
110+
gh repo edit --description "..."
111+
gh repo edit --add-topic topic-1 --add-topic topic-2 ...
112+
```
113+
114+
2. **Generate and upload social preview** (if provider configured):
115+
- Generate image via configured provider
116+
- Upload to repository if `upload_to_repo: true`
117+
118+
3. **Update README.md**:
119+
- Insert/update badge section
120+
- Add infographic placeholder/image
121+
122+
4. **Report results**:
123+
- Confirm each step completed
124+
- Provide GitHub settings links for manual steps
125+
126+
## Example Usage
127+
128+
```bash
129+
# Preview all enhancements
130+
/github-social:all
131+
132+
# Apply all changes automatically
133+
/github-social:all --apply
134+
135+
# Dry run to see what would change
136+
/github-social:all --dry-run
137+
138+
# Skip certain features
139+
/github-social:all --apply --skip-infographic
140+
/github-social:all --apply --skip-badges
141+
```
142+
143+
## Tips
144+
145+
- Run without `--apply` first to review changes
146+
- Ensure `gh` CLI is authenticated for metadata updates
147+
- Configure `.claude/github-social.local.md` for image generation
148+
- Social preview requires manual GitHub settings update after upload
149+
- Use `--dry-run` to safely preview all changes
150+
151+
## Related Commands
152+
153+
- `/social-preview` - Generate social preview image only
154+
- `/repo-metadata` - Generate metadata only
155+
- `/readme-enhance` - Enhance README only
156+
- `/github-social:setup` - Configure plugin settings

0 commit comments

Comments
 (0)