Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JamoDevNich authored Aug 5, 2018
1 parent 775d7f3 commit 42a4919
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ Python 3.3 and above, tested on both Windows and Linux. No third party libraries
### Authenticating
There are several ways to authenticate with your SuperHub. The easiest way is to run the script and type your password when prompted. Alternatively, the password can be provided via the command line argument `--password`, or if you so desire, permanently edited into the script through the `superhub_password` variable.

### Output modes
There are a variety of output modes available through command line arguments. The `--format` argument allows you to specify a `json` or `console` output format, where the latter is the default. When outputting in json format, using the `--silent` switch is recommended as this will only output the result of the request. A `--verbose` mode is also available.

## Functions
### Toggling Guest and Private WLAN
The guest networks and private WLAN networks can be toggled via the menu, or by specifying the `--wlan` argument. The parameters are as follows: 0-Disable Private Wlan, 1-Enable Private WLAN, 2-Disable Guest WLAN, 3-Enable Guest WLAN. The Guest WLAN may not be available when the private WLAN is deactivated.
Expand All @@ -23,3 +20,10 @@ This utility will overwrite the default username and password for your Guest WLA
To view the clients list, simply run the script and type the **client** option in the menu. Alternatively you can specify the `--clients` command line option. You will be presented with a list of connected and previously connected clients, similar to the one shown below.

![Image](https://i.imgur.com/bkLiHQ2.png)

## Misc
### Output modes
There are a variety of output modes available through command line arguments. The `--format` argument allows you to specify a `json` or `console` output format, where the latter is the default. When outputting in json format, using the `--silent` switch is recommended as this will only output the result of the request. A `--verbose` mode is also available.

### Feature suggestions
Feel free to open a new issue with a feature suggestion, or fork/pull request.

0 comments on commit 42a4919

Please sign in to comment.