Skip to content

Commit

Permalink
Added setCursor() method documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
stvwhtly committed May 26, 2015
1 parent 11df95d commit d2dd54f
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ Installation
Options
-------


Option | Default | Description
--------------|-------------------------------------|------------
text | `['one','two','three']` (array) | List of strings to output.
Expand All @@ -43,6 +42,15 @@ Options
callbackNext | `null` (function) | Callback function called every text item. See `Callback functions` below.
callbackType | `null` (function) | Callback function called every 'letter'. See `Callback functions` below.

Methods
-------

**teletype.setCursor(string cursor)**

Change the cursor value. Can be used at any time although particularly useful
when combined with callback functions.


Deleting characters `~`
---

Expand Down

0 comments on commit d2dd54f

Please sign in to comment.