README生成ツール（GitHub用README.md）

優れたREADMEはプロジェクトの顔です。プロジェクトが何をするのか、どうインストールして使うのか、どう貢献するのかを伝え、GitHub・npm・GitLabで人々が最初に目にするドキュメントです。このジェネレーターは、短いフォームから、読者が期待するセクション、つまりバッジ、説明、機能、インストール、使い方、技術スタック、API、コントリビュート、ライセンス、作者を備えた完全なREADME.mdを作成し、レンダリング済みのHTMLも取得できます。

使い方

1. プロジェクト名、1行の説明、GitHubリポジトリ（owner/name）を入力します。
2. 機能、インストールコマンド、使用例を入力します。空欄にしたセクションは省かれます。
3. ライセンスと、バッジ・スクリーンショットのプレースホルダー・コントリビュートの案内・目次などの追加項目を選びます。
4. MarkdownをリポジトリのルートのREADME.mdにコピーします。

計算式

# 名前 → バッジ → 説明 → About → Features → Built with → Installation → Usage → API → Contributing → License → Author

内容のないセクションは省かれます。コードは、コード内のバッククォートの連続より長いフェンスを持つコードブロックに入れるため、何も壊れません。バッジにはshields.ioを使い、静的なライセンスバッジ（"-"はshields.ioの規則どおり"--"と書く）、npmのバージョンとダウンロード数、GitHubのスター・イシュー・最終コミットがあります。目次のリンクはGitHubの見出しアンカーの規則（小文字、空白はハイフン、句読点は除去）に従います。HTML版はmarkedライブラリのGitHub風（GFM）モードで作成します。

計算例

サンプルはawesome-cliのREADMEを作成します。ライセンスのバッジとGitHubのバッジ3つ、1行の説明、Aboutの段落、機能3つ、「Built with」の下のNode.jsとTypeScript、cloneコマンドに続くnpm install -g awesome-cli、使い方のブロック、貢献の手順、MITライセンスの行、作者まで、合計8セクションです。