From 8e1af4c65a48c25cf9da3c5f3b1a9e66eb9fc487 Mon Sep 17 00:00:00 2001 From: Sebastian Hildebrandt Date: Fri, 23 Jun 2017 12:51:02 +0200 Subject: [PATCH] updated docs --- CHANGELOG.md | 1 + README.md | 20 ++++++++++---------- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 90e42ad..cc90811 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -98,6 +98,7 @@ Other changes | Version | Date | Comment | | -------------- | -------------- | -------- | +| 3.23.3 | 2017-06-23 | updated docs | | 3.23.2 | 2017-06-23 | bug fix `battery` (windows) | | 3.23.1 | 2017-06-22 | updated docs | | 3.23.0 | 2017-06-22 | added `memLayout`, `diskLayout`, extended windows support (`inetChecksite`)| diff --git a/README.md b/README.md index 5f45f67..6282f61 100644 --- a/README.md +++ b/README.md @@ -437,13 +437,13 @@ si.networkStats('eth1') .catch(error => console.error(error)); ``` -### About Temperature +### Known Issues -#### OSX +#### OSX - Temperature Sensor -Due to some difficulties in NPM with `optionalDependencies` I unfortunately -was getting unexpected warnings on other platforms. So I decided to drop temperature -measurement for OSX - or more specific the automatic installation of the needed dependency. +To be able to measure temperature on OSX I created a litte additional package. Due to some difficulties +in NPM with `optionalDependencies` I unfortunately was getting unexpected warnings on other platforms. +So I decided to drop this optional dependencies for OSX - so by default, you will not get correct values. But if you need to detect OSX temperature just run the following additional installation command: @@ -454,14 +454,14 @@ $ npm install osx-temperature-sensor --save `systeminformation` will then detect this additional library and return the temperature when calling systeminformations standard function `cpuTemperature()` -#### Windows +#### Windows Temperature, Battery, ... -`wmic` - which is used to determine the temperature sometimes needs to be run with admin -privileges. So if you do not get any temperature value, try to run it again with according +`wmic` - which is used to determine temperature and battery sometimes needs to be run with admin +privileges. So if you do not get any values, try to run it again with according privileges. If you still do not get any values, your system might not support this feature. -In some cases we also discovered that `wmic` returned incorrect values. +In some cases we also discovered that `wmic` returned incorrect temperature values. -#### Linux +#### Linux Temperature In some cases you need to install the linux `sensors` package to be able to measure temperature e.g. on DEBIAN based systems by running `sudo apt-get install lm-sensors`