Sketch for 0.3 docs

README.md

@@ -2,11 +2,16 @@
 
 # OhmGraphite
 
-OhmGraphite takes the hard work of extracting hardware sensors from [Open Hardware Monitor](http://openhardwaremonitor.org/) (technically [LibreHardwareMonitor](https://github.com/LibreHardwareMonitor/LibreHardwareMonitor) for most up to date hardware) and exports the data in a [graphite](https://graphiteapp.org/) compatible format. If you're missing GPU, temperature, or power metrics in [Grafana](https://grafana.com/) or (or other graphite UI), this tool is for you!
+OhmGraphite takes the hard work of extracting hardware sensors from [Open Hardware Monitor](http://openhardwaremonitor.org/) (technically [LibreHardwareMonitor](https://github.com/LibreHardwareMonitor/LibreHardwareMonitor) for most up to date hardware) and exports the data in a [graphite](https://graphiteapp.org/) (or [InfluxdDB](https://www.influxdata.com/)) compatible format. If you're missing any of the following in [Grafana](https://grafana.com/) or (other time series UI), this tool is for you!
+
+- Breakdown of GPU utilization
+- Fan speed
+- Temperature for hard drives, CPU cores, GPU, Motherboard
+- Voltage readings
 
 ## Who's this for?
 
-- People who are familiar with Graphite / Grafana and may have an instance running on their home or cloud server. If you're not familiar with those applications, it may be overwhelming to setup and maintain them. If you're just looking for a UI for hardware sensors, I'd recommend [HWINFO](https://www.hwinfo.com/)
+- People who are familiar with Graphite / InfluxDB / Grafana and may have an instance running on their home or cloud server. If you're not familiar with those applications, it may be overwhelming to setup and maintain them. If you're just looking for a UI for hardware sensors, I'd recommend [HWINFO](https://www.hwinfo.com/)
 - People who have administrative privileges
 - People who know how to execute commands on Windows Command Prompt or other terminal
 - People who like lightweight (8MB of RAM and neglible CPU usage), portable (can run off usb), and straightforward applications
@@ -15,7 +20,7 @@ OhmGraphite takes the hard work of extracting hardware sensors from [Open Hardwa
 
 OhmGraphite functions as a console app (cross platform) or a Windows service that periodically polls the hardware. My recommendation is that even though OhmGraphite can be run via Mono / Docker, many hardware sensors aren't available in those modes.
 
-Don't fret if this repo hasn't been updated recently. I use this every day to create beautiful dashboards. Keep in mind, Open Hardware Monitor supported components will determine what metrics are available. Below are graphs / stats made with OhmGraphite (couple of the panels are complemented with [telegraf](https://github.com/influxdata/telegraf) as demonstrated in [Monitoring Windows system metrics with grafana](https://nbsoftsolutions.com/blog/monitoring-windows-system-metrics-with-grafana))
+I use this every day to create beautiful dashboards. Keep in mind, Open Hardware Monitor supported components will determine what metrics are available. Below are graphs / stats made with OhmGraphite (couple of the panels are complemented with [telegraf](https://github.com/influxdata/telegraf) as demonstrated in [Monitoring Windows system metrics with grafana](https://nbsoftsolutions.com/blog/monitoring-windows-system-metrics-with-grafana))
 
 [![dashboard](https://github.com/nickbabcock/OhmGraphite/raw/master/assets/dashboard.png)](https://github.com/nickbabcock/OhmGraphite/raw/master/assets/dashboard.png)
 
@@ -23,7 +28,15 @@ Don't fret if this repo hasn't been updated recently. I use this every day to cr
 
 - Create a directory that will home base for OhmGraphite (I use C:\Apps\OhmGraphite).
 - Download the [latest zip](https://github.com/nickbabcock/OhmGraphite/releases/latest) and extract to our directory.
-- Update app configuration (located at `OhmGraphite.exe.config`). The config below polls our hardware every `5` seconds and sends the results to a graphite server listening on `localhost:2003`.
+- Update app configuration (located at `OhmGraphite.exe.config`) using either the Graphite config or InfluxDB config
+- This config can be updated in the future, but will require a restart of the app for effect.
+- The app can be ran interactively by executing `.\OhmGraphite.exe run`. Executing as administrator will most likely increase the number of sensors found (OhmGraphite will log how many sensors are found).
+- To install the app `.\OhmGraphite.exe install`. The command will install OhmGraphite as a Windows service (so you can manage it with your favorite powershell commands or `services.msc`)
+- To start the app after installation: `.\OhmGraphite.exe start` or your favorite Windows service management tool
+
+### Graphite Configuration
+
+The config below polls our hardware every `5` seconds and sends the results to a graphite server listening on `localhost:2003`.
 
 ```xml
 <?xml version="1.0" encoding="utf-8" ?>
@@ -36,10 +49,23 @@ Don't fret if this repo hasn't been updated recently. I use this every day to cr
 </configuration>
 ```
 
-- This config can be updated in the future, but will require a restart of the app for effect.
-- The app can be ran interactively by executing `.\OhmGraphite.exe run`. Executing as administrator *may* make difference in the number of sensors found (OhmGraphite will log how many sensors are found).
-- To install the app `.\OhmGraphite.exe install`. The command will install OhmGraphite as a Windows service (so you can manage it with your favorite powershell commands or `services.msc`)
-- To start the app after installation: `.\OhmGraphite.exe start` or your favorite Windows service management tool
+### InfluxDB Configuration
+
+```xml
+<?xml version="1.0" encoding="utf-8" ?>
+<configuration>
+  <appSettings>
+    <add key="type" value="influxdb" />
+    <add key="interval" value="5" />
+    <add key="influx_address" value="http://localhost:8086" />
+    <add key="influx_db" value="mydb" />
+<!--
+    <add key="influx_user" value="myuser" />
+    <add key="influx_password" value="mypassword" />
+-->
+  </appSettings>
+</configuration>
+```
 
 ### Upgrades