summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Kreutz <mail@skreutz.com>2022-05-23 22:33:45 +0200
committerStefan Kreutz <mail@skreutz.com>2022-05-23 22:33:45 +0200
commitcd4ced47bcd35a40a3b44402a7b6af996a6f94b8 (patch)
tree4d68dc84b9a95fc502313e06baf77c54c57f3916
parent8a57eecad5d7b094f9411e1cad398d0a62b1c72d (diff)
downloadwpa-psk-cd4ced47bcd35a40a3b44402a7b6af996a6f94b8.tar
Describe usage
-rw-r--r--README.md21
1 files changed, 17 insertions, 4 deletions
diff --git a/README.md b/README.md
index 56dc177..66ac7c2 100644
--- a/README.md
+++ b/README.md
@@ -2,16 +2,29 @@
This is a command-line utility and Rust library to compute the WPA pre-shared key of a Wi-Fi SSID and passphrase.
-## Example
+## Usage
-I've created the tool to connect to wireless networks with *special* or technically *invalid* SSIDs and passphrases:
+Hash a typcial SSID and passphrase:
+
+ $ wpa-psk home password123
+ 0xde811641af2c516ffd35cc6f851b3abf03c7c84fc703cfb580f1c0456943cdc0
+
+Hash *special* albeit valid credentials:
$ wpa-psk "123abcABC.,-" "456defDEF *<:D"
0x8a366e5bc51cd5d8fbbeffacc5f1af23fac30e3ac93cdcc368fafbbf63a1085c
- $ wpa-psk --force "bar" "2short"
+Hash *invalid* credentials:
+
+ $ wpa-psk --force bar 2short
0xcb5de4e4d23b2ab0bf5b9ba0fe8132c1e2af3bb52298ec801af8ad520cea3437
+## Installation
+
+You can install `wpa-psk` using Cargo:
+
+ $ cargo install wpa-psk
+
## License
This work is distributed under the terms of both, the [MIT License](LICENSE-MIT) and the [Apache License, Version 2.0](LICENSE-APACHE-2.0).
@@ -19,7 +32,7 @@ This work is distributed under the terms of both, the [MIT License](LICENSE-MIT)
## Contribution
Contributions are welcome!
-Please contact me via email.
+Please [contact](https://www.skreutz.com/contact/) me via email.
## See also
Generated by cgit. See skreutz.com for my tech blog and contact information.