Skip to content

Commit

Permalink
update the installation and usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
reugn committed Aug 25, 2021
1 parent 45bc830 commit 1d137b9
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ Create a QR code with your Wi-Fi login details.
Use Google Lens or other application to scan it and connect automatically.

## Installation
Pick a binary from the [releases](https://github.com/reugn/wifiqr/releases).

### Build from source
Download and install Go https://golang.org/doc/install.

Clone the repository:
Expand All @@ -30,8 +33,8 @@ Usage of ./wifiqr:
The wireless network encryption protocol (WEP, WPA, WPA2). (default "WPA2")
-file string
A png file to write the QR Code (prints to stdout if not set).
-hidden string
Hidden SSID true/false. (default "false")
-hidden
Hidden SSID.
-key string
A pre-shared key (PSK). You'll be prompted to enter the key if not set.
-size int
Expand Down

0 comments on commit 1d137b9

Please sign in to comment.