Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history 
beautify readme davejacobs#13
  • Loading branch information
@muescha
muescha committed Oct 6, 2012
1 parent 58f2612 commit c4bd981
Showing 1 changed file with 276 additions and 0 deletions.
276 changes: 276 additions & 0 deletions README.md
View file
Expand Up @@ -56,6 +56,280 @@ The `o` method takes options, too, so you can add a prefix message to the output

### Available letters

<table>
<tr><th>Letter</th><th>Command</th><th>Option(s)</th><th>Description</th></tr>

<tr>
<td>
<a href="http://lettersrb.com/api#a">a</a>
</td>
<td>
<strong>A</strong>ssert
</td>
<td>
:message
:error_class
</td>
<td>
asserts in the context of its receiver or Letters::AssertionError
</td>
</tr>

<tr>
<td>
<a href="http://lettersrb.com/api#b">b</a>
</td>
<td>
<strong>B</strong>eep
</td>
<td>
</td>
<td>
causes your terminal to beep
</td>
</tr>

<tr>
<td>
<a href="http://lettersrb.com/api#c">c</a>
</td>
<td>
<strong>C</strong>allstack
</td>
<td>
:message
</td>
<td>
prints the current callstack
</td>
</tr>

<tr>
<td>
<a href="http://lettersrb.com/api#d">d</a>
</td>
<td>
<strong>D</strong>ebugger
</td>
<td>

</td>
<td>
passes control to the debugger
</td>
</tr>

<tr>
<td>
<a href="http://lettersrb.com/api#d1d2">d1 d2</a>
</td>
<td>
<strong>D</strong>iff
</td>
<td>
:message
:format
:stream
</td>
<td>
prints a diff between first and second receivers
</td>
</tr>

<tr>
<td>
<a href="http://lettersrb.com/api#e">e</a>
</td>
<td>
<strong>E</strong>mpty
</td>
<td>
:message
</td>
<td>
raises a Letters::EmptyError if its receiver is empty
</td>
</tr>

<tr>
<td>
<a href="http://lettersrb.com/api#f">f</a>
</td>
<td>
<strong>F</strong>ile
</td>
<td>
:format :name
</td>
<td>
writes its receiver into a file in a given format
</td>
</tr>

<tr>
<td>
<a href="http://lettersrb.com/api#j">j</a>
</td>
<td>
<strong>J</strong>ump
</td>
<td>
(&block)
</td>
<td>
executes its block in the context of its receiver
</td>
</tr>

<tr>
<td>
<a href="http://lettersrb.com/api#k">k</a>
</td>
<td>
<strong>K</strong>ill
</td>
<td>
:max
</td>
<td>
raises Letters::KillError after a maximum number of calls
</td>
</tr>

<tr>
<td>
<a href="http://lettersrb.com/api#l">l</a>
</td>
<td>
<strong>L</strong>ogger
</td>
<td>
:format :level
</td>
<td>
logs its receivers on the available logger instance
</td>
</tr>

<tr>
<td>
<a href="http://lettersrb.com/api#m">m</a>
</td>
<td>
<strong>M</strong>ark as Taint
</td>
<td>
(<strong>true</strong>|false)
</td>
<td>
taints (or untaints) its receiver
</td>
</tr>

<tr>
<td>
<a href="http://lettersrb.com/api#n">n</a>
</td>
<td>
<strong>N</strong>il
</td>
<td>

</td>
<td>
raises a Letters::NilError if its receiver is nil
</td>
</tr>

<tr>
<td>
<a href="http://lettersrb.com/api#o">o</a>
</td>
<td>
std<strong>O</strong>ut
</td>
<td>
:format :stream
</td>
<td>
prints its receiver to standard output
</td>
</tr>

<tr>
<td>
<a href="http://lettersrb.com/api#r">r</a>
</td>
<td>
<strong>R</strong>i
</td>
<td>
(method name as symbol)
</td>
<td>
prints RI documentation of its receiver class
</td>
</tr>

<tr>
<td>
<a href="http://lettersrb.com/api#s">s</a>
</td>
<td>
<strong>S</strong>afety
</td>
<td>
(level number)
</td>
<td>
bumps the safety level (by one or as specified)
</td>
</tr>


<tr>
<td>
<a href="http://lettersrb.com/api#t">t</a>
</td>
<td>
<strong>T</strong>imestamp
</td>
<td>
:time_format
</td>
<td>
prints out the current timestamp
</td>
</tr>

</table>

See full documentation at http://lettersrb.com/api



````
Letter Command Option(s) Description
a Assert :message :error_class asserts in the context of its receiver or Letters::AssertionError
b Beep causes your terminal to beep
c Callstack :message prints the current callstack
d Debugger passes control to the debugger
d1 d2 Diff :message :format :stream prints a diff between first and second receivers
e Empty :message raises a Letters::EmptyError if its receiver is empty
f File :format :name writes its receiver into a file in a given format
j Jump (&block) executes its block in the context of its receiver
k Kill :max raises Letters::KillError after a maximum number of calls
l Logger :format :level logs its receivers on the available logger instance
m Mark as taint (true|false) taints (or untaints) its receiver
n Nil raises a Letters::NilError if its receiver is nil
o stdOut :format :stream prints its receiver to standard output
r Ri (method name as symbol) prints RI documentation of its receiver class
s Safety (level number) bumps the safety level (by one or as specified)
t Timestamp :time_format prints out the current timestamp
````

See also full documentation at http://lettersrb.com/api

- `a` (Assert) asserts in the context of its receiver or Letters::AssertionError
- `b` (Beep) causes your terminal to beep
- `c` (Callstack) prints the current callstack
Expand All @@ -72,3 +346,5 @@ The `o` method takes options, too, so you can add a prefix message to the output
- `r` (Ri) prints RI documentation of its receiver class
- `s` (Safety) bumps the safety level (by one or as specified)
- `t` (Timestamp) prints out the current timestamp

See full documentation at http://lettersrb.com/api

0 comments on commit c4bd981

Please sign in to comment.