Skip to content

Commit 7adaaf6

Browse files
committed
Update readme
1 parent b17353c commit 7adaaf6

File tree

1 file changed

+28
-27
lines changed

1 file changed

+28
-27
lines changed

README.md

Lines changed: 28 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ ANSI escape codes for manipulating the terminal
33

44
[![version](https://img.shields.io/npm/v/ansi-escape.svg)](https://www.npmjs.org/package/ansi-escape)
55
[![status](https://travis-ci.org/zoubin/ansi-escape.svg?branch=master)](https://travis-ci.org/zoubin/ansi-escape)
6-
[![dependencies](https://david-dm.org/zoubin/ansi-escape.svg)](https://david-dm.org/zoubin/ansi-escape)
7-
[![devDependencies](https://david-dm.org/zoubin/ansi-escape/dev-status.svg)](https://david-dm.org/zoubin/ansi-escape#info=devDependencies)
86

97
## Usage
108

@@ -39,45 +37,45 @@ Output:
3937
## Cursors
4038

4139
### cursorUp(n = 1)
42-
### cuu(n = 1)
43-
### up(n = 1)
40+
41+
Alias: `cuu`, `up`
4442

4543
Moves the cursor `n` cells up.
4644

4745
### cursorDown(n = 1)
48-
### cud(n = 1)
49-
### down(n = 1)
46+
47+
Alias: `cud`, `down`
5048

5149
Moves the cursor `n` cells down.
5250

5351
### cursorForward(n = 1)
54-
### cuf(n = 1)
55-
### forward(n = 1)
52+
53+
Alias: `cuf`, `forward`
5654

5755
Moves the cursor `n` cells forward.
5856

5957
### cursorBackward(n = 1)
60-
### cub(n = 1)
61-
### back(n = 1)
58+
59+
Alias: `cub`, `back`
6260

6361
Moves the cursor `n` cells backward.
6462

6563

6664
### cursorColumn(n = 1)
67-
### cha(n = 1)
68-
### col(n = 1)
65+
66+
Alias: `cha`, `col`
6967

7068
Moves the cursor to column `n`.
7169

7270
### cursorPosition(n = 1, m = 1)
73-
### cup(n = 1, m = 1)
71+
72+
Alias: `cup`
7473

7574
Moves the cursor to row `n`, column `m`.
7675

7776
### eraseDisplay(n = 0)
78-
### eraseDisplayEnd
79-
### eraseDisplayStart
80-
### eraseDisplayEntire
77+
78+
Sugar: `eraseDisplayEnd`, `eraseDisplayStart`, `eraseDisplayEntire`
8179

8280
Clears part of the screen.
8381

@@ -86,9 +84,8 @@ Clears part of the screen.
8684
* If `n` is 2, clear entire screen (and moves cursor to upper left on DOS ANSI.SYS).
8785

8886
### eraseLine(n = 0)
89-
### eraseLineEnd
90-
### eraseLineStart
91-
### eraseLineEntire
87+
88+
Sugar: `eraseLineEnd`, `eraseLineStart`, `eraseLineEntire`
9289

9390
Erases part of the line.
9491

@@ -99,36 +96,40 @@ Erases part of the line.
9996
Cursor position does not change.
10097

10198
### scrollUp(n = 1)
102-
### su(n = 1)
99+
100+
Alias: `su`
103101

104102
Scroll whole page up by n (default 1) lines.
105103
New lines are added at the bottom.
106104

107105
### scrollDown(n = 1)
108-
### sd(n = 1)
106+
107+
Alias: `sd`
109108

110109
Scroll whole page down by n (default 1) lines.
111110
New lines are added at the top.
112111

113112
### saveCursorPosition
114-
### saveCursor
115-
### scp
113+
114+
Alias: `scp`, `saveCursor`
116115

117116
Saves the cursor position.
118117

119118
### restoreCursorPosition
120-
### restoreCursor
121-
### rcp
119+
120+
Alias: `rcp`, `restoreCursor`
122121

123122
Restores the cursor position.
124123

125124
### hideCursor
126-
### hide
125+
126+
Alias: `hide`
127127

128128
Hides the cursor.
129129

130130
### showCursor
131-
### show
131+
132+
Alias: `show`
132133

133134
Shows the cursor.
134135

0 commit comments

Comments
 (0)