github-readme

Installation
SKILL.md

GitHub README

Use this skill to produce a README that helps visitors decide quickly whether to use the project and how to get started.

Goal

A good GitHub README should answer, in order:

  1. What is this project?
  2. Why should I use it?
  3. How do I run it right now?
  4. How do I configure common cases?
  5. How do I contribute?

Workflow

  1. Identify audience and primary use case.
  2. Write a short value-first opening section.
  3. Add a runnable quickstart with copy-pastable commands.
Related skills

More from nateberkopec/dotfiles

Installs
3
GitHub Stars
98
First Seen
Apr 7, 2026