Skip to content

Instantly share code, notes, and snippets.

@sotayamashita
Last active April 10, 2016 11:10
Show Gist options
  • Save sotayamashita/28a4067b3acada7a224b to your computer and use it in GitHub Desktop.
Save sotayamashita/28a4067b3acada7a224b to your computer and use it in GitHub Desktop.
๐Ÿ“ Be a great README tips

Great Readme

๐Ÿ“ Be a great README tips

Badge

https://img.shields.io/badge/<left side>-<right side>-<color>.svg?style=<plastic|flat|flat-square>

sample

Sample badge

Qiita

Note

Diff

// Bad:
const hero = {
     firstName: 'Florence',
-    lastName: 'Nightingale'
+    lastName: 'Nightingale',
+    inventorOf: ['coxcomb graph', 'modern nursing']
};

// Good:
const hero = {
     firstName: 'Florence',
     lastName: 'Nightingale',
+    inventorOf: ['coxcomb chart', 'modern nursing'],
};

Ref: https://github.com/babel/example-node-server

Keyborad

Ctrl `

Ref: sindresorhus/ama#131

Unix command

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment