Skip to content

Commit f418227

Browse files
author
opensourcegeek
committed
Amended README for 0.5.0 merge
1 parent 7c7731d commit f418227

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,29 +16,32 @@ Download the binaries 'stest-i686-linux' for 32-bit or 'stest-x86_64-linux' for
1616
Usage
1717
-----
1818

19-
Supported options given below. Argument parsing is powered by awesome https://github.com/kbknapp/clap-rs
19+
Supported options given below. Argument parsing is powered by awesome [clap-rs](https://github.com/kbknapp/clap-rs)
2020

2121
```
2222
USAGE:
23-
stest [OPTIONS]
23+
stest [FLAGS] [OPTIONS]
2424
2525
FLAGS:
26-
-h, --help Prints help information
27-
-V, --version Prints version information
26+
-h, --help Prints help information
27+
-u, --use-cached Use a cached copy of servers
28+
-V, --version Prints version information
2829
2930
OPTIONS:
3031
-c, --csv <csv> Set name of csv file
3132
-n, --number-tests <number_tests> Sets number of tests to run
3233
-s, --server-country <server_country>
33-
This will scan servers only from given country name - it might take a while before it finds the best server
34+
This will scan servers only from given country name - it might take a while before it
35+
finds the best server
3436
-o, --server-country-code <server_country_code>
35-
This will scan servers only from given country code - it might take a while before it finds the best server
37+
This will scan servers only from given country code - it might take a while before it
38+
finds the best server
39+
3640
```
3741

3842

3943
to-do
4044
-----
4145

42-
- Add a switch to use local cache for servers to avoid downloading each time.
4346
- Add command line switches to use specific server, override geo-ip lookup.
4447
- Add command line argument to run in server mode (no security) again rendering CSV/JSON file. I'm thinking websocket but not sure!

0 commit comments

Comments
 (0)