Skip to content

Commit 7c06db1

Browse files
committed
Update README.md with --text mode section
1 parent d91f9bd commit 7c06db1

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,30 @@ On Unix based systems (e.g. MacOS or GNU Linux):
132132

133133
This file follows the same pattern matching principles as other `.gitignore` or `.ignore` files and has a lower precedence than all other sources of ignore rules.
134134

135+
### `--text` mode
136+
137+
Text mode allows for either piping through stdin, e.g.:
138+
139+
```bash
140+
echo 'Hello World' | stdrename --text -k
141+
```
142+
143+
or interactive use, e.g.:
144+
145+
```bash
146+
stdrename --text -s
147+
reallyCreativeProgramName.js
148+
really_creative_program_name.js
149+
PYTHONISTA_BANANA.py
150+
pythonista_banana.py
151+
This is really just a normal sentence
152+
this_is_really_just_a_normal_sentence
153+
```
154+
155+
Either way, the program terminates and stops reading as soon as it encounters an empty line.
156+
157+
To suppress the exit message (if piping stdout to another file for example) add the `-q` or `--quiet` flag.
158+
135159
## License
136160

137161
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FGadiguibou%2Fstdrename.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FGadiguibou%2Fstdrename?ref=badge_large)

0 commit comments

Comments
 (0)