From 4c28e0ac8e11eef9b5e943550f5c9dd420bc30e7 Mon Sep 17 00:00:00 2001 From: Sebastian Hildebrandt Date: Sun, 26 Apr 2020 11:22:50 +0200 Subject: [PATCH] updated docs --- README.md | 2 ++ docs/gettingstarted.html | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e7487c3..b7ad5e5 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,8 @@ Lightweight collection of 40+ functions to retrieve detailed hardware, system an - supports Linux, macOS, partial Windows, FreeBSD, OpenBSD, NetBSD and SunOS support - no npm dependencies (for production) +**Attention**: this is a `node.js` library. It is supposed to be used as a backend/server-side library and will definilely not work within a browser. + ### Installation ```bash diff --git a/docs/gettingstarted.html b/docs/gettingstarted.html index 79ac04f..078806e 100644 --- a/docs/gettingstarted.html +++ b/docs/gettingstarted.html @@ -56,7 +56,7 @@

Core Concept

Node.js comes with some basic OS information, but I always wanted a little more. So I came up to write this - little library. This library is still work in progress. It is supposed to be used as a backend/server-side library (will definilely not work within a browser). It requires node.js version 4.0 and above.

+ little library. This library is still work in progress. It is supposed to be used as a node.js backend/server-side library (will definilely not work within a browser). It requires node.js version 4.0 and above.

I was able to test it on several Debian, Raspbian, Ubuntu distributions as well as macOS (Mavericks, Yosemite, El Captain, Sierra, High Sierra, Mojave) and some Windows 7, Windows 10, FreeBSD, OpenBSD, NetBSD and SunOS machines. Not all functions are supported on all operating systems. Have a look at the function reference in the docs to get further details.