Merge pull request #28 from DevSecNinja/master

Enhance user documentation

README.md

@@ -26,9 +26,14 @@ Note: You'll get a Windows Smartscreen warning because the code was self signed.
 
 ### Standalone
 
-You'll need [.NET 5 Runtime](https://dotnet.microsoft.com/download/dotnet/current/runtime) installed.
+If you don't want to use the installer, standalone is what you need. Make sure to install [.NET 5 Runtime](https://dotnet.microsoft.com/download/dotnet/current/runtime) first. Find the standalone version releases on GitHub [here](https://github.com/sleevezipper/hass-workstation-service/releases). Unpack all files to a folder and run `hass-workstation-service.exe`. This is the background service and you can use `UserInterface.exe` to configure the service. There is no automatic (or prompted) updating in the standalone version.
 
-If you don't want to use the installer, you can find the standalone version releases on GitHub [here](https://github.com/sleevezipper/hass-workstation-service/releases). Unpack all files to a folder and run `hass-workstation-service.exe`. This is the background service and you can use `UserInterface.exe` to configure the service. There is no automatic (or prompted) updating in the standalone version.
+### Getting Started
+
+As a prerequisite, make sure you have an MQTT username and password available. Using Home Assistant in combination with the Mosquitto broker add-on and integration? You can both use a Home Assistant account and a local account. From a security perspective, we recommend a local account as this only provides access to the MQTT Broker and not to your Home Assistant instance.
+
+Now that you are all set, make sure to run the `hass-workstation-service.exe` executable first. This executable is responsible for setting up the sensors and talking with your MQTT Broker. To configure the service, start the `UserInterface.exe` executable.
+Add your `hostname` or `IP address`, `port`, `username` and `password` and click on Save. In case you use the Mosquitto add-in, provide port `8883` and check `Use TLS`. The application will mention "All good" when configured correctly.
 
 ### Updating
 
@@ -38,6 +43,17 @@ If you used the installer, the app checks for updates on startup. If an update i
 
 Find us on us on [Discord](https://discord.gg/VraYT2N3wd).
 
+## Development
+
+Want to develop or build the application yourself? Make sure to install the .NET Runtime [.NET 5 Runtime](https://dotnet.microsoft.com/download/dotnet/current/runtime) and [.NET 5 SDK](https://dotnet.microsoft.com/download/dotnet/current). Run the following commands from the `hass-workstation-service\hass-workstation-service` directory to get you started:
+
+```` powershell
+dotnet build
+dotnet publish
+````
+
+In case you are using Visual Studio Code, open the `hass-workstation-service\hass-workstation-service` folder to take advantage of the predefined build and publish tasks.
+
 ## Sensors
 
 The application provides several sensors. Sensors can be configured with a name and this name will be used in the MQTT topic like this: `homeassistant/sensor/{DeviceName}/{Name}/state`. Sensors will expose themselves through [MQTT discovery](https://www.home-assistant.io/docs/mqtt/discovery/) and will automatically appear in Home assistant or any other platform that supports this type of configuration.

UserInterface/Views/AppInfo.axaml

@@ -9,7 +9,7 @@
       <ContentControl FontSize="18" FontWeight="Bold" >Info</ContentControl>
       <TextBlock Text="Need some help?" Margin="0 0 0 20"></TextBlock >
       <StackPanel Margin="0 0 0 20" HorizontalAlignment="Left" Orientation="Horizontal">
-        <Button Width="75" HorizontalAlignment="Right" Margin="10 10" Click="Github">Github</Button>
+        <Button Width="75" HorizontalAlignment="Right" Margin="10 10" Click="GitHub">GitHub</Button>
         <Button Width="75" HorizontalAlignment="Left" Margin="10 10" Click="Discord">Discord</Button>
       </StackPanel>
     </StackPanel>

UserInterface/Views/AppInfo.axaml.cs

@@ -64,7 +64,7 @@ namespace UserInterface.Views
             }
         }
 
-        public void Github(object sender, RoutedEventArgs args)
+        public void GitHub(object sender, RoutedEventArgs args)
         {
             BrowserUtil.OpenBrowser("https://github.com/sleevezipper/hass-workstation-service");
         }

UserInterface/Views/BrokerSettings.axaml

@@ -5,10 +5,10 @@
              mc:Ignorable="d" d:DesignWidth="500" d:DesignHeight="450"
              x:Class="UserInterface.Views.BrokerSettings">
   <StackPanel Margin="30" HorizontalAlignment="Left">
-    <ContentControl FontSize="18" FontWeight="Bold">Mqtt broker</ContentControl>
+    <ContentControl FontSize="18" FontWeight="Bold">MQTT Broker</ContentControl>
     <TextBlock IsVisible="{Binding IsConnected}" Foreground="Green" Text="{Binding Message}"></TextBlock >
     <TextBlock IsVisible="{Binding !IsConnected}" Foreground="Red" Text="{Binding Message}"></TextBlock >
-    <ContentControl Margin="0 20 0 10">IP or hostname</ContentControl>
+    <ContentControl Margin="0 20 0 10">IP address or hostname</ContentControl>
     <TextBox Text="{Binding Host}" HorizontalAlignment="Left" Width="100" Watermark="192.168.1.200"/>
     <StackPanel Orientation="Horizontal">
       <StackPanel Orientation="Vertical">