write-readme

README: Be Brief

When writing a README, be brief. Do not include licensing or contribution sections.

Always show a cheatsheet that demonstrates the command-line interface. Show the CLI in a code block with a short one-line comment above it indicating its purpose.

The Shape

One code block holds every invocation, each under its own one-line comment.

Do not give each example its own fenced block, its own prose sentence, or its own heading.

# find files where tags include "python"
islandiguana ./notes '.tags[] == "python"'

# find files up to 1 level deep
islandiguana --max-depth 1 ./notes '.tags[] == "python"'