Use the diff
code highlighting tag.
```diff
- foo
+ bar
Example:
# ======================================= | |
# OS X — ONE CLICK — EJECT ALL DISKS | |
# ======================================= | |
# Open Script Editor on OS X | |
# Copy and paste this file in | |
# Save As > Application | |
# Name it "Eject All Disks" | |
# Drag created application to Dock | |
# Now you can eject all external disks with one click from Dock | |
# ??? |
Byobu is a suite of enhancements to tmux, as a command line | |
tool providing live system status, dynamic window management, | |
and some convenient keybindings: | |
F1 * Used by X11 * | |
Shift-F1 Display this help | |
F2 Create a new window | |
Shift-F2 Create a horizontal split | |
Ctrl-F2 Create a vertical split | |
Ctrl-Shift-F2 Create a new session |
function map (fn, list) { | |
var end = list.length | |
var idx = -1 | |
var out = [] | |
while (++idx < end) { | |
out.push(fn(list[idx])) | |
} | |
return out | |
} |
At the top of the file there should be a short introduction and/ or overview that explains what the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)
Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.