Skip to content

Commit

Permalink
Add stdin information to README
Browse files Browse the repository at this point in the history
  • Loading branch information
WKHAllen committed Mar 9, 2020
1 parent 1835ec4 commit 25cc02b
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,38 @@ A C program that unscrambles words.

## Usage

To use the unscrambler, simply run the program and pass the scrambled word as the primary argument. Example:
To use the unscrambler, simply run the program and pass the scrambled word as the primary argument.

```console
$ unscramble loelh
hello
```

To use a different dictionary, use -d. Example:
If no word is provided, standard input will be used.

```console
$ unscramble -d dict/british-english locoru
$ unscramble
> cats
| acts
| cast
| cats
| scat
> else
| eels
| else
| lees
>
$
```

To exit the standard input prompt, provide no input.

### Dictionaries

To use a different dictionary, use -d.

```console
$ unscramble -d british-english locoru
colour
```

Expand Down

0 comments on commit 25cc02b

Please sign in to comment.