write-readme

README：简明扼要

编写 README 时，请简明扼要。不要包含许可或贡献章节。

务必展示一份演示命令行界面的速查表。将 CLI 放在代码块中，并在上方用一行简短注释说明其用途。

结构

所有命令调用都放在一个代码块中，每条命令各自配有一行注释。

不要为每个示例单独使用围栏代码块、单独写一段说明文字，也不要单独设标题。

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

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

# delete a front matter key from all matched files
islandiguana ./notes '.filetype == "product"' --mutate 'del(.filetype)'

说明文字应放在代码块上方或下方，用于介绍工具的用途，以及读者无法自行推断的规则。

不要在命令之间插入说明文字。

输出

是否展示输出是可选的，大多数速查表都不会展示。

如果展示输出，必须遵守捕获的输出必须真实而非虚构这一规则。这条规则不要求示例必须展示输出，也不能作为给每条命令都配上输出代码块的理由。

如果命令的结果是重点，例如 JSON 记录或解析错误，就展示该结果。