Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
greenberga authored Jul 9, 2018
1 parent bfdd890 commit 643d3fe
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# `choose`

`choose` is a command line utility that randomly selects items from a list passed on standard input. It takes as arguments the number of items to choose as well as the character(s) used to delimit list items.

## Examples

```
$ seq 100 | choose 5
67
69
7
38
38
```

```
$ echo -e 'A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z' | choose 3 -d ,
T
D
E
```

## Help

```
./target/release/choose --help
choose 0.1.0
Aaron Greenberg <[email protected]>
a command line tool for random selection from a list
USAGE:
choose [OPTIONS] [count]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-d <delimiter> list delimiter [default:
]
ARGS:
<count> number of items to choose [default: 1]
```

0 comments on commit 643d3fe

Please sign in to comment.