updated README

Extractor/README.md

@@ -0,0 +1,57 @@
+# Extractor
+
+ A simple .Net Framework 3.5 tool that extracts embeeded files into the target directory, installs the .Net Core runtime if necesary and installs the Windows service.
+
+## Preparation
+
+ Put the service executable and all other necesary files into the `Embeeded` directory, and change their `Build Action` in the `Properties` to `Embedded Resource`.
+
+ Modify the `Extractor.Program` fields as needed:
+
+ ```cs
+static readonly string DotNetRuntime = "DotNetCore-3.1.21-win-x64.exe";
+static readonly string ServiceConfig = "config.json";
+static readonly string[] Dependencies = new string[] {
+        "Microsoft.Win32.SystemEvents.dll",
+        "MQTTnet.dll",
+        "MqttSql.deps.json",
+        "MqttSql.dll",
+        "MqttSql.runtimeconfig.json",
+        "Newtonsoft.Json.dll",
+        "SQLite.Interop.dll",
+        "System.Data.SQLite.dll",
+        "System.Diagnostics.EventLog.dll",
+        "System.ServiceProcess.ServiceController.dll",
+        "Topshelf.dll",
+        "TopShelf.ServiceInstaller.dll"
+    };
+static readonly string Service = "MqttSql.exe";
+ ```
+
+ Build the project.
+
+## Installation
+
+ Just run the executable as admin. Alternatively, you may pass the path to the target directory as the first argument from the command line.
+
+## MIT License
+
+Copyright (c) 2021 Guiorgy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,2 +1,70 @@
 # MqttSql
- .Net Core Windows service that subscribes to a MQTT broker and writes the messages into a local SQLite database
+
+ A simple .Net Core Windows service that subscribes to MQTT brokers and writes the messages into a local SQLite database
+
+## Configuration
+
+ The service will look for a `config.json` file in the same directory with the executable. A sample of the configuration file:
+
+ ```json
+[
+  {
+    "host": "192.168.0.101",
+    "port": 1883,
+    "user": "user1",
+    "password": "password1",
+    "topic": "some/tpic/1",
+    "table": "table1"
+  },
+  {
+    "host": "192.168.0.102",
+    "port": 1883,
+    "user": "user2",
+    "password": "password2",
+    "topic": "some/topic/2",
+    "table": "table2"
+  }
+]
+ ```
+
+ Where `table` is the name of the table to create and write to in the SQLite database. The database will also be placed in the same directory with the name `database.sqlite`.
+
+## Installation
+
+ This project uses [TopShelf](https://github.com/Topshelf/Topshelf) to manage the Windows service.
+
+ To install the windows service, open an elevated shell window using navigate to the directory with the executable, for example:
+
+ `cd "C:\Program Files\MqttSql`
+
+ And run the executable with `install` and `start` arguments, for example:
+
+ `.\MqttSql.exe install start`
+
+ To unregister and uninstall the service, run the executable with the `uninstall` argument, for example:
+
+ `.\MqttSql.exe uninstall`
+
+ Alternatively, you can use the Extractor tool included in the project, which will put all the necesary files into the target directory, install the .Net Core runtime if necesary and install the service.
+
+## MIT License
+
+Copyright (c) 2021 Guiorgy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.