diff options
| author | Eduardo Broto <ebroto@tutanota.com> | 2019-12-20 20:28:55 +0100 |
|---|---|---|
| committer | Eduardo Broto <ebroto@tutanota.com> | 2019-12-20 20:28:55 +0100 |
| commit | 6436b7d70a5947d5fa2e6232ca2f858d4f5b8827 (patch) | |
| tree | d642d4eefbde5c09e35f5bbb3a5370b6215a6264 /README.md | |
| parent | d2a9434f157cbcc6ecfa37988c4951563f30fbf4 (diff) | |
docs(readme): Update usage and some uses after making -i optional
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 6 |
1 files changed, 3 insertions, 3 deletions
@@ -29,7 +29,7 @@ Windows is not supported at the moment - if you'd like to contribute a windows p ### Usage ``` USAGE: - what [FLAGS] --interface <interface> + what [FLAGS] [OPTIONS] FLAGS: -h, --help Prints help information @@ -46,14 +46,14 @@ Note that since `what` sniffs network packets, it requires root privileges - so ### raw_mode `what` also supports an easier-to-parse mode that can be piped or redirected to a file. For example, try: ``` -what -i eth0 --raw | grep firefox +what --raw | grep firefox ``` ### Contributing Contributions of any kind are very welcome. If you'd like a new feature (or found a bug), please open an issue or a PR. To set up your development environment: 1. Clone the project -2. `cargo run -- -i <network interface name>` (you can often find out the name with `ifconfig` or `iwconfig`). You might need root privileges to run this application, so be sure to use (for example) sudo. +2. `cargo run`, or if you prefer `cargo run -- -i <network interface name>` (you can often find out the name with `ifconfig` or `iwconfig`). You might need root privileges to run this application, so be sure to use (for example) sudo. To run tests: `cargo test` |