Skip to content

Commit 77e311f

Browse files
committed
chore: added -o readme notes
1 parent 06f0afe commit 77e311f

File tree

4 files changed

+3413
-6
lines changed

4 files changed

+3413
-6
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,15 @@ Selected data is also output to _stdout_ allowing for easily composing various w
5959
<br />
6060

6161
<p align="center">
62-
<img alt="demo animation" width="600" src="https://cdn.rawgit.com/ruyadorno/ipt/master/demo.svg" />
62+
<img alt="demo animation" width="600" src="https://ruyadorno.github.io/svg-demos/ipt-demos/demo.svg" />
6363
</p>
6464

6565
<br />
6666

6767
## :newspaper: News
6868

69+
- **v3.1.0:**
70+
- Added `-o` option for ordered multiple choice selection
6971
- **v2.1.0:**
7072
- Added `-D` option for defining a pre-selected item in the list
7173
- **v2.0.0:**
@@ -128,7 +130,7 @@ Here we get a simple list of branchs `git branch -a`, pipe into `ipt` and pipe t
128130
<br />
129131

130132
<p align="center">
131-
<img alt="`git branch -a | ipt | xargs git checkout` selects a branch name from menu and that branch gets checked out by git" width="600" src="https://cdn.rawgit.com/ruyadorno/ipt/master/example/git-checkout.svg" />
133+
<img alt="`git branch -a | ipt | xargs git checkout` selects a branch name from menu and that branch gets checked out by git" width="600" src="https://ruyadorno.github.io/svg-demos/ipt-demos/input.svg" />
132134
</p>
133135

134136
<br/>
@@ -141,20 +143,22 @@ In the following example we list all the files from the folder `ls` and pipe tha
141143
<br />
142144

143145
<p align="center">
144-
<img alt="`ls | ipt -m | xargs rm` selects multiple items from the menu and deletes them" width="600" src="https://cdn.rawgit.com/ruyadorno/ipt/master/example/rm.svg" />
146+
<img alt="`ls | ipt -m | xargs rm` selects multiple items from the menu and deletes them" width="600" src="https://ruyadorno.github.io/svg-demos/ipt-demos/multiple.svg" />
145147
</p>
146148

147149
<br/>
148150
<br/>
149151

152+
**NOTE:** An ordered multiple choice menu is available when using the `-o` OR `--ordered` option
153+
150154
### Using file as input data
151155

152156
You can also read a file as source of input data instead of reading from the standard input, here we read from a `TODO` file and redirect the selected items to be written in a `DONE` file.
153157

154158
<br />
155159

156160
<p align="center">
157-
<img alt="Selects multiple lines from a file and append them to another one" width="600" src="https://cdn.rawgit.com/ruyadorno/ipt/master/example/input.svg" />
161+
<img alt="Selects multiple lines from a file and append them to another one" width="600" src="https://ruyadorno.github.io/svg-demos/ipt-demos/input.svg" />
158162
</p>
159163

160164
<br/>
@@ -203,6 +207,7 @@ Options:
203207
-e, --file-encoding Encoding for file <path>, defaults to utf8 [string]
204208
-h, --help Shows this help message [boolean]
205209
-m, --multiple Allows the selection of multiple items [boolean]
210+
-o, --ordered Selects multiple items in order [boolean]
206211
-M, --message Replaces interface message [string]
207212
-p, --extract-path Returns only a valid path for each item [boolean]
208213
-s, --separator Separator to to split input into items [string]

example/multiple.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)