READMEに書くこと

概要（コードが実行していること）

インストール方法

トラブルシューティング手順

コードのメンテナー

ライセンス情報

更新履歴

基本的な例

より詳細な情報やドキュメントへのリンク