good-readme

good-readme について

オープンソースプロジェクトの README.md を作成または改善する。README、プロジェクト説明、ライブラリ・フレームワーク・ツールの「はじめに」ドキュメントの作成、書き直し、レビュー、推敲、あるいはオープンソースプロジェクトをより人気にしユーザーにとって魅力的にするあらゆる依頼に使用する。内部/プライベートリポジトリのドキュメント、API リファレンスの生成、CHANGELOG/CONTRIBUTING ファイルには使用しない。