68 lines
1.9 KiB
Markdown
68 lines
1.9 KiB
Markdown
# github-presence
|
|
|
|
**Platform optimization skill** — Optimize GitHub for discoverability and conversions.
|
|
|
|
## What It Does
|
|
|
|
Guides you through GitHub optimization: README structure, badges, profile README, topics, awesome lists, GitHub Actions for marketing, and Sponsors setup.
|
|
|
|
## When to Use
|
|
|
|
- Improving a project README
|
|
- Setting up a profile README
|
|
- Increasing GitHub discoverability
|
|
- When you say "GitHub README," "GitHub profile," "awesome lists," or "GitHub marketing"
|
|
|
|
## Quick Start
|
|
|
|
```
|
|
/github-presence
|
|
|
|
Audit our GitHub README and suggest improvements.
|
|
We're an open source database tool trying to get
|
|
more stars and contributors.
|
|
```
|
|
|
|
## Key Sections
|
|
|
|
1. **README Structure** — Anatomy of a great README
|
|
2. **Badges** — Which ones matter and how to add them
|
|
3. **Profile README** — Personal branding on GitHub
|
|
4. **Discoverability** — Topics, search, awesome lists
|
|
5. **GitHub Actions** — Automation for marketing
|
|
6. **GitHub Sponsors** — Monetization setup
|
|
|
|
## README Must-Haves
|
|
|
|
| Section | Purpose |
|
|
|---------|---------|
|
|
| Logo/Banner | Visual identity |
|
|
| Badges | Trust signals |
|
|
| One-liner | What it does |
|
|
| Quick Start | < 2 min to running |
|
|
| Features | Why use this |
|
|
| Installation | All methods |
|
|
| Documentation | Link to full docs |
|
|
| License | Legal clarity |
|
|
|
|
## Discoverability Tactics
|
|
|
|
| Tactic | How |
|
|
|--------|-----|
|
|
| Topics | Add up to 20 relevant topics |
|
|
| Description | 350 chars, keyword-rich |
|
|
| Awesome lists | Submit PRs to curated lists |
|
|
| Social preview | Upload custom image |
|
|
|
|
## Tools
|
|
|
|
- **[Octolens](https://octolens.com)** — Monitor GitHub mentions and discussions
|
|
- **Shields.io** — Generate badges
|
|
- **readme.so** — README generator
|
|
|
|
## Related Skills
|
|
|
|
- `developer-audience-context` — Know who evaluates your repo
|
|
- `hacker-news-strategy` — HN users check GitHub first
|
|
- `reddit-engagement` — Redditors evaluate via GitHub
|