Skip to content

Commit 4de863d

Browse files
committed
update readme
1 parent cc056b2 commit 4de863d

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ long-running-command 2>&1 | progressline
3333

3434
## Features
3535

36-
### Change Activity Indicator Styles
36+
### Change activity indicator styles
3737

38-
**ProgressLine** offers different styles to represent activity, they can be changed using `-s, --activity-style` argument:
38+
ProgressLine offers different styles to represent activity, they can be changed using `-s, --activity-style` option:
3939

4040
``` sh
4141
long-running-command | progressline --activity-style snake
@@ -47,21 +47,25 @@ Available styles:
4747
|:--:|:--:|:--:|
4848
| ![](./.github/activity_style_dots.gif) | ![](./.github/activity_style_snake.gif) | ![](./.github/activity_style_kitt.gif) |
4949

50+
### Replace log output with custom text
51+
52+
If you don't need to see the log output during execution, even in a single line, you can replace it with your own text using the `-t, --static-text` option.
53+
54+
``` sh
55+
long-running-command | progressline --static-text "Updating sources..."
56+
```
57+
5058
### Highlight important lines
5159

52-
Log specific stdin lines above the progress line using the `-m, --log-matches` argument:
60+
Log specific stdin lines above the progress line using the `-m, --log-matches` option:
5361

5462
``` sh
5563
long-running-command | progressline --log-matches "regex-1" --log-matches "regex-2"
5664
```
5765

58-
| output |
59-
|:--:|
60-
| ![](./.github/progressline_matches_output.png) |
61-
6266
### Use progress line as an addition to standard output
6367

64-
Log all stdin data above the progress line using the `-a, --log-all` argument:
68+
Log all stdin data above the progress line using the `-a, --log-all` option:
6569

6670
```sh
6771
long-running-command | progressline --log-all
@@ -77,7 +81,7 @@ You have two options for saving the full original log:
7781
long-running-command | tee original-log.txt | progressline
7882
```
7983

80-
2. Using `-l, --original-log-path` argument:
84+
2. Using `-l, --original-log-path` option:
8185

8286
``` sh
8387
long-running-command | progressline --original-log-path original-log.txt

0 commit comments

Comments
 (0)