Merge pull request #11 from reugn/develop

v0.3.0

.codecov.yml

@@ -0,0 +1,5 @@
+coverage:
+ status:
+ project:
+ default:
+ target: 80%

.github/workflows/test-coverage.yml

@@ -0,0 +1,21 @@
+name: Test Coverage
+
+on: [push, pull_request]
+
+jobs:
+ test:
+ runs-on: ubuntu-latest
+ strategy:
+ matrix:
+ go-version: [1.17.x]
+ steps:
+ - name: Setup Go
+ uses: actions/setup-go@v2
+ with:
+ go-version: ${{ matrix.go-version }}
+ - name: Checkout code
+ uses: actions/checkout@v2
+ - name: Run coverage
+ run: go test . -coverprofile=coverage.out -covermode=atomic
+ - name: Upload coverage to Codecov
+ run: bash <(curl -s https://codecov.io/bash)

.gitignore

@@ -2,3 +2,4 @@
 .idea/
 /wifiqr
 dist/
+coverage.out

README.md

@@ -1,50 +1,66 @@
-# Wi-Fi QR Code generator
+# Wi-Fi QR Code Generator
+
 <img src="docs/images/qr.png" align='right'/>
 
 [![Test Status](https://github.com/reugn/wifiqr/workflows/Test/badge.svg)](https://github.com/reugn/wifiqr/actions?query=workflow%3ATest)
-[![PkgGoDev](https://pkg.go.dev/badge/github.com/reugn/wifiqr?tab=doc)](https://pkg.go.dev/github.com/reugn/wifiqr?tab=doc)
+[![PkgGoDev](https://pkg.go.dev/badge/github.com/reugn/wifiqr)](https://pkg.go.dev/github.com/reugn/wifiqr)
 [![Go Report Card](https://goreportcard.com/badge/github.com/reugn/wifiqr)](https://goreportcard.com/report/github.com/reugn/wifiqr)
+[![codecov](https://codecov.io/gh/reugn/wifiqr/branch/main/graph/badge.svg)](https://codecov.io/gh/reugn/wifiqr)
 
 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.
+Choose a binary from the [releases](https://github.com/reugn/wifiqr/releases).
+
+### Build from Source
+
+Download and [install Go](https://golang.org/doc/install).
 
 Get the package:
+
 ```sh
 go get github.com/reugn/wifiqr
 ```
 
 Read this [guide](https://golang.org/doc/tutorial/compile-install) on how to compile and install the application.
 
 ## Usage
+
 ```text
-Usage of ./wifiqr:
- -enc string
- 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
- Hidden SSID.
- -key string
- A pre-shared key (PSK). You'll be prompted to enter the key if not set.
- -size int
- Size is both the image width and height in pixels. (default 256)
- -ssid string
- The name of the wireless network. You'll be prompted to enter the SSID if not set.
- -version
- Show version.
+$ wifiqr --help
+wifiqr is a WiFi QR code generator
+
+It is used to create a QR code containing the login details such as
+the name, password, and encryption type. This QR code can be scanned
+using Google Lens or other QR code reader to connect to the network.
+It is Android and iOS compatible.
+
+If the options necessary for creating the QR code are not given on
+the command line, the user will be prompted for the information.
+
+Usage:
+ wifiqr [flags]
+
+Flags:
+ -h, --help help for wifiqr
+ --hidden Hidden SSID
+ -k, --key string Wireless password (pre-shared key / PSK)
+ -o, --output string PNG file for output (default stdout)
+ -p, --protocol string Wireless network encryption protocol (WPA2, WPA, WEP, NONE). (default "WPA2")
+ -s, --size int Image width and height in pixels (default 256)
+ -i, --ssid string Wireless network name
+ -v, --version version for wifiqr
 ```
 
-## Usage example
+## Usage Example
+
 ```sh
-./wifiqr -ssid some_ssid -key 1234 -file qr.png -size 128
+./wifiqr --ssid some_ssid --key 1234 --output qr.png --size 128
 ```
 
 ## License
-MIT
+
+MIT