readme-writer

Installation
SKILL.md

The general flow of a README:

  1. A section describing what the package does and why it's important (i.e. "what's in it for me" for the user)
  2. A section on how to install and use the package
  3. A section on common configuration options and methods
  4. A section on how to contribute or pointer to CONTRIBUTING.md, notes on the developer's build environment and potential portability problems.
  5. a brief explanation of any unusual top-level directories or files, or other hints for readers to find their way around the source;

Github-flavored markdown

Since most all of my projects are Github, you have have some neat markdown block extensions available:

[!CAUTION] [!IMPORTANT] [!NOTE] [!TIP] [!WARNING]

Use these to call out any semantic sections.

Installs
6
GitHub Stars
108
First Seen
Jan 22, 2026
readme-writer — nateberkopec/dotfiles