diff --git a/README.md b/README.md index 255dc8f..a6862d8 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,18 @@ **fbsh-cli** - FritzBox SmartHome Console Client ## Configuration File -To set some default settings and create the configuration file, just run `./fbsh-cli -host *HOSTNAME* -user *USERNAME* -pass *PASSWORD* saveconfig` +To set some default settings and create the configuration file, just run the command. -The default configuration will be saved under $HOME/.fbsh.config. +`./fbsh-cli -host http://192.168.0.1 -user SOMEUSER -pass SOMEPASSWORD saveconfig` + +The default configuration will be saved under `$HOME/.fbsh.config`. In addition the client will save a SID file `.fbsh.sid` which contains the last known SID (session ID). This file will also be located inside the home directory. + +## Check the Login +Test the connection with `./fbsh-cli connect`. The successfull conntion will look like: + + user@desktop ~/FBSmartHome $ ./fbsh-cli connect + SID:989346018a2dca53 + user@desktop ~/FBSmartHome $ ## Supported Commands + saveconfig @@ -13,3 +22,6 @@ The default configuration will be saved under $HOME/.fbsh.config. + list + help + +## Currently Not Working ++ HTTPS is yet not supported