updated docs

This commit is contained in:
Sebastian Hildebrandt 2025-01-03 11:14:01 +01:00
parent 61e7dc2ada
commit aac258fa13
3 changed files with 12 additions and 5 deletions

View File

@ -67,6 +67,15 @@ appreciated - [Buy me a coffee](https://www.buymeacoffee.com/systeminfo).
**Your contribution** make it possible for me to keep working on this project,
add new features and support more platforms. Thank you in advance!
## Node.js ✅, Bun ✅ and Deno ✅
I tested this library with Node.js, Bun and Deno (V2.x) with no issues. There is
currently only one problem on Denos side: os.freemem() pollyfill is currently
not correct (version 2.1.4) bus there is already a fix (not yet published).
**Attention**: This library is supposed to be used as a backend/server-side
library and **will definitely not work within a browser**.
## New Version 5.0
The new Version 5 is here - this next major version release 5.0 comes with new
@ -109,9 +118,6 @@ and OS information.
Android support
- no npm dependencies
**Attention**: this is a `node.js` library. It is supposed to be used as a
backend/server-side library and will definitely not work within a browser.
### Installation
```bash

View File

@ -54,6 +54,7 @@
<li>get detailed information about system, cpu, baseboard, battery, memory, disks/filesystem, network, docker, software, services and processes</li>
<li>supports Linux, macOS, partial Windows, FreeBSD, OpenBSD, NetBSD, SunOS and Android support</li>
<li>no npm dependencies</li>
<li>for Node.js &#x2705;, Bun &#x2705;and Deno &#x2705;</li>
</ul>
<h2>Core Concept</h2>
@ -66,7 +67,7 @@
<p>I also created a nice little command line tool called <a href="https://github.com/sebhildebrandt/mmon" rel="nofollow">mmon</a> (micro-monitor) for Linux and macOS, also available via <a href="https://github.com/sebhildebrandt/mmon" rel="nofollow">github</a> and <a href="https://npmjs.org/package/mmon" rel="nofollow">npm</a></p>
<h4>Attention:</h4>
<p>This library is supposed to be used as a <a href="https://nodejs.org/en/" rel="nofollow">node.js</a> backend/server-side library and will definitely not work within a browser.</p>
<p>This library is supposed to be used as a <a href="https://nodejs.org/en/" rel="nofollow">node.js</a>, <a href="https://bun.sh" rel="nofollow">Bun</a> or <a href="https://deno.com" rel="nofollow">Deno</a> backend/server-side library and will definitely not work within a browser.</p>
<h2>Installation</h2>
<pre>$ npm install systeminformation --save</pre>

View File

@ -186,7 +186,7 @@
<div class="row">
<div class="col-12 sectionheader index">
<div class="title">Overview</div>
<div class="subtitle">Node.js system information package. Lightweight collection of 50+ functions to retrieve detailed hardware, system and OS information. For Linux, macOS, partial Windows, FreeBSD, OpenBSD, NetBSD, SunOS and Android support. Dependency free.</div>
<div class="subtitle">Node.js system information package. Lightweight collection of 50+ functions to retrieve detailed hardware, system and OS information. For Linux, macOS, partial Windows, FreeBSD, OpenBSD, NetBSD, SunOS and Android support. Dependency free. Works with <span class="bold">Node.js</span>, <span class="bold">Bun</span> and <span class="bold">Deno</span></div>
<div class="subtitle bold">#1 NPM ranking for backend packages</div>
<div class="npmicons">
<a href="https://npmjs.org/package/systeminformation" rel="nofollow"><img src="https://img.shields.io/npm/v/systeminformation.svg?style=flat-square" alt="NPM Version" data-canonical-src="https://img.shields.io/npm/v/systeminformation.svg?style=flat-square" style="max-width:100%;"></a>