diff --git a/README.md b/README.md index 7e3e0b8..2f2792b 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,11 @@ go build . ## Running instructions ```bash -% ./gordle --help +% ./gordle --help + Usage of ./gordle: + -f string + Path to dictionary file with words of length -n. If specified, -n must be specified too (if the latter must not be equal to default value (default "./dictionary/5.txt") -n int Word size (default 5) ``` @@ -28,4 +31,4 @@ go test # [-cover] ## Dictionaries -To run game you also need dictionary files. By default gordle searches for them in `./dictionary/.txt` file, where `` - number of characters, specified by `-n` flag +To run game you also need dictionary files. By default gordle searches for them in `./dictionary/.txt` file, where `` - number of characters, specified by `-n` flag. If want to use custom one, provide in `-f` flag path to txt file with strings separated by new line characters