Skip to content

Commit aac258f

Browse files
updated docs
1 parent 61e7dc2 commit aac258f

File tree

3 files changed

+12
-5
lines changed

3 files changed

+12
-5
lines changed

README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,15 @@ appreciated - [Buy me a coffee](https://www.buymeacoffee.com/systeminfo).
6767
**Your contribution** make it possible for me to keep working on this project,
6868
add new features and support more platforms. Thank you in advance!
6969

70+
## Node.js ✅, Bun ✅ and Deno ✅
71+
72+
I tested this library with Node.js, Bun and Deno (V2.x) with no issues. There is
73+
currently only one problem on Denos side: os.freemem() pollyfill is currently
74+
not correct (version 2.1.4) bus there is already a fix (not yet published).
75+
76+
**Attention**: This library is supposed to be used as a backend/server-side
77+
library and **will definitely not work within a browser**.
78+
7079
## New Version 5.0
7180

7281
The new Version 5 is here - this next major version release 5.0 comes with new
@@ -109,9 +118,6 @@ and OS information.
109118
Android support
110119
- no npm dependencies
111120

112-
**Attention**: this is a `node.js` library. It is supposed to be used as a
113-
backend/server-side library and will definitely not work within a browser.
114-
115121
### Installation
116122

117123
```bash

docs/gettingstarted.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@
5454
<li>get detailed information about system, cpu, baseboard, battery, memory, disks/filesystem, network, docker, software, services and processes</li>
5555
<li>supports Linux, macOS, partial Windows, FreeBSD, OpenBSD, NetBSD, SunOS and Android support</li>
5656
<li>no npm dependencies</li>
57+
<li>for Node.js &#x2705;, Bun &#x2705;and Deno &#x2705;</li>
5758
</ul>
5859

5960
<h2>Core Concept</h2>
@@ -66,7 +67,7 @@ <h2>Core Concept</h2>
6667
<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>
6768

6869
<h4>Attention:</h4>
69-
<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>
70+
<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>
7071

7172
<h2>Installation</h2>
7273
<pre>$ npm install systeminformation --save</pre>

docs/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
<div class="row">
187187
<div class="col-12 sectionheader index">
188188
<div class="title">Overview</div>
189-
<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>
189+
<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>
190190
<div class="subtitle bold">#1 NPM ranking for backend packages</div>
191191
<div class="npmicons">
192192
<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>

0 commit comments

Comments
 (0)