From c88315a50423eb8565a2d17053c921edd0d87e15 Mon Sep 17 00:00:00 2001 From: Sebastian Hildebrandt Date: Tue, 19 Jan 2021 19:31:31 +0100 Subject: [PATCH] updated docs --- docs/audio.html | 3 + docs/battery.html | 3 + docs/bluetooth.html | 3 + docs/changes.html | 3 + docs/contributors.html | 3 + docs/copyright.html | 3 + docs/cpu.html | 3 + docs/docker.html | 3 + docs/filesystem.html | 3 + docs/general.html | 3 + docs/gettingstarted.html | 9 ++- docs/graphics.html | 3 + docs/history.html | 3 + docs/index.html | 3 + docs/issues.html | 3 + docs/main.js | 1 + docs/memory.html | 3 + docs/network.html | 3 + docs/os.html | 3 + docs/printer.html | 3 + docs/processes.html | 3 + docs/security.html | 3 + docs/statsfunctions.html | 3 + docs/system.html | 3 + docs/tests.html | 158 +++++++++++++++++++++++++++++++++++++++ docs/trademarks.html | 3 + docs/usb.html | 3 + docs/vbox.html | 3 + docs/wifi.html | 3 + 29 files changed, 243 insertions(+), 3 deletions(-) create mode 100644 docs/tests.html diff --git a/docs/audio.html b/docs/audio.html index 184563c..d3b91ee 100644 --- a/docs/audio.html +++ b/docs/audio.html @@ -228,6 +228,7 @@ si.audio().then(data => console.log(data));
  •  
  • Security Advisories  
  • Github
    • +
  •  
  •   Buy me a coffee
    • @@ -236,6 +237,7 @@ si.audio().then(data => console.log(data));
  • Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -244,6 +246,7 @@ si.audio().then(data => console.log(data)); @@ -284,6 +285,7 @@ si.battery().then(data => console.log(data));
  • Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -292,6 +294,7 @@ si.battery().then(data => console.log(data)); @@ -200,6 +201,7 @@ si.bluetoothDevices().then(data => console.log(data));Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -208,6 +210,7 @@ si.bluetoothDevices().then(data => console.log(data));
  • Contributors
  • Trademarks
    • +
  •  
  • Copyright & License  MIT license
  • © 2021 Sebastian Hildebrandt
  • +innovations GmbH
    • diff --git a/docs/changes.html b/docs/changes.html index 31c367e..8363144 100644 --- a/docs/changes.html +++ b/docs/changes.html @@ -117,6 +117,7 @@
  •  
  • Security Advisories  
  • Github
    • +
  •  
  •   Buy me a coffee
    • @@ -125,6 +126,7 @@
  • Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -133,6 +135,7 @@ @@ -93,6 +94,7 @@
  • Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -101,6 +103,7 @@ @@ -109,6 +110,7 @@
  • Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -117,6 +119,7 @@ @@ -598,6 +599,7 @@ si.cpuTemperature().then(data => console.log(data));Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -606,6 +608,7 @@ si.cpuTemperature().then(data => console.log(data));
  • Contributors
  • Trademarks
    • +
  •  
  • Copyright & License  MIT license
  • © 2021 Sebastian Hildebrandt
  • +innovations GmbH
    • diff --git a/docs/docker.html b/docs/docker.html index c4e019f..97b6bc9 100644 --- a/docs/docker.html +++ b/docs/docker.html @@ -1054,6 +1054,7 @@
  •  
  • Security Advisories  
  • Github
    • +
  •  
  •   Buy me a coffee
    • @@ -1062,6 +1063,7 @@
  • Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -1070,6 +1072,7 @@ @@ -869,6 +870,7 @@ setInterval(function() {
  • Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -877,6 +879,7 @@ setInterval(function() { @@ -388,6 +389,7 @@ si.get(valueObject).then(data => console.log(data));Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -396,6 +398,7 @@ si.get(valueObject).then(data => console.log(data));
  • Contributors
  • Trademarks
    • +
  •  
  • Copyright & License  MIT license
  • © 2021 Sebastian Hildebrandt
  • +innovations GmbH
    • diff --git a/docs/gettingstarted.html b/docs/gettingstarted.html index 6bab402..4d04809 100644 --- a/docs/gettingstarted.html +++ b/docs/gettingstarted.html @@ -47,7 +47,7 @@
    Quick Start
    -

    Lightweight collection of 45+ functions to retrieve detailed hardware, system and OS information.

    +

    Lightweight collection of 50+ functions to retrieve detailed hardware, system and OS information.

    • simple to use
    • get detailed information about system, cpu, baseboard, battery, memory, disks/filesystem, network, docker, software, services and processes
      • @@ -64,7 +64,7 @@

      If you have comments, suggestions & reports, please feel free to contact me on github!

      I also created a nice little command line tool called mmon (micro-monitor) for Linux and macOS, also available via github and npm

      -

      Attention:

      +

      Attention:

      This library is supposed to be used as a node.js backend/server-side library and will definilely not work within a browser.

      Installation

      @@ -128,7 +128,7 @@ async function cpuData() { console.log(e) } }
      -

      Issues

      +

      Issues

      If you discover some empty or incorrect values, please be sure to first have a look at the Known issues section.

    @@ -146,6 +146,7 @@ async function cpuData() {
  •  
  • Security Advisories  
  • Github
    • +
  •  
  •   Buy me a coffee
    • @@ -154,6 +155,7 @@ async function cpuData() {
  • Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -162,6 +164,7 @@ async function cpuData() { @@ -530,6 +531,7 @@ si.graphics().then(data => console.log(data));
  • Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -538,6 +540,7 @@ si.graphics().then(data => console.log(data)); @@ -2029,6 +2030,7 @@
  • Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -2037,6 +2039,7 @@ @@ -371,6 +372,7 @@
  • Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -379,6 +381,7 @@ @@ -103,6 +104,7 @@
  • Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -111,6 +113,7 @@ @@ -402,6 +403,7 @@ si.memLayout().then(data => console.log(data));
  • Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -410,6 +412,7 @@ si.memLayout().then(data => console.log(data)); @@ -789,6 +790,7 @@ setInterval(function() {
  • Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -797,6 +799,7 @@ setInterval(function() { @@ -741,6 +742,7 @@ si.users().then(data => console.log(data));
  • Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -749,6 +751,7 @@ si.users().then(data => console.log(data)); @@ -225,6 +226,7 @@ si.printer().then(data => console.log(data));
  • Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -233,6 +235,7 @@ si.printer().then(data => console.log(data)); @@ -740,6 +741,7 @@ si.services('mysql, postgres').then(data => console.log(data));Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -748,6 +750,7 @@ si.services('mysql, postgres').then(data => console.log(data));
  • Contributors
  • Trademarks
    • +
  •  
  • Copyright & License  MIT license
  • © 2021 Sebastian Hildebrandt
  • +innovations GmbH
    • diff --git a/docs/security.html b/docs/security.html index dc6a8fc..c12cf94 100644 --- a/docs/security.html +++ b/docs/security.html @@ -109,6 +109,7 @@
  •  
  • Security Advisories  
  • Github
    • +
  •  
  •   Buy me a coffee
    • @@ -117,6 +118,7 @@
  • Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -125,6 +127,7 @@ @@ -143,6 +144,7 @@ setTimeout(() => {
  • Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -151,6 +153,7 @@ setTimeout(() => { @@ -436,6 +437,7 @@ si.chassis().then(data => console.log(data));
  • Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -444,6 +446,7 @@ si.chassis().then(data => console.log(data)); @@ -101,6 +102,7 @@
  • Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -109,6 +111,7 @@ @@ -260,6 +261,7 @@ si.usb().then(data => console.log(data));
  • Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -268,6 +270,7 @@ si.usb().then(data => console.log(data)); @@ -462,6 +463,7 @@
  • Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -470,6 +472,7 @@ @@ -239,6 +240,7 @@ si.wifiNetworks().then(data => console.log(data));
  • Quick Start
  • Version 5 Changes
  • Full Version history
    • +
  • Testing
  • Known Issues
  • Stats Functions
    • @@ -247,6 +249,7 @@ si.wifiNetworks().then(data => console.log(data));