updated docs
This commit is contained in:
Sebastian Hildebrandt
parent
58721f8a88
commit
1d1bf0a7c9
@ -27,6 +27,7 @@
|
||||
[![Code Quality: Javascript][lgtm-badge]][lgtm-badge-url]
|
||||
[![Total alerts][lgtm-alerts]][lgtm-alerts-url]
|
||||
[![Caretaker][caretaker-image]][caretaker-url]
|
||||
[![Sponsoring][sponsor-badge]][sponsor-url]
|
||||
[![MIT license][license-img]][license-url]
|
||||
|
||||
This is amazing. Started as a small project just for myself, it now has > 9,000 lines of code, > 250 versions published, up to 1 mio downloads per month, > 4 mio downloads overall. Thank you to all who contributed to this project!
|
||||
@ -850,6 +851,9 @@ All other trademarks are the property of their respective owners.
|
||||
[lgtm-alerts]: https://img.shields.io/lgtm/alerts/g/sebhildebrandt/systeminformation.svg?style=flat-square
|
||||
[lgtm-alerts-url]: https://lgtm.com/projects/g/sebhildebrandt/systeminformation/alerts
|
||||
|
||||
[sponsor-badge]: https://img.shields.io/badge/-Buy%20me%20a%20coffee-blue?style=flat-square
|
||||
[sponsor-url]: https://www.buymeacoffee.com/systeminfo
|
||||
|
||||
[license-url]: https://github.com/sebhildebrandt/systeminformation/blob/master/LICENSE
|
||||
[license-img]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
|
||||
[npmjs-license]: https://img.shields.io/npm/l/systeminformation.svg?style=flat-square
|
||||
|
||||
@ -248,8 +248,7 @@ si.battery().then(data => console.log(data));</code></pre class="example">
|
||||
model: '',
|
||||
manufacturer: 'Apple',
|
||||
serial: 'F9Y19860Y9AH9XBAX'
|
||||
}
|
||||
</pre>
|
||||
}</pre>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
@ -311,8 +311,7 @@ si.cpu().then(data => console.log(data));</code></pre class="example">
|
||||
socket: 'LGA1151',
|
||||
cache: { l1d: 262144, l1i: 262144, l2: 2, l3: 16 },
|
||||
flags: 'fpu vme de pse ...'
|
||||
}
|
||||
</pre>
|
||||
}</pre>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>si.cpuFlags(cb)</td>
|
||||
|
||||
@ -295,6 +295,44 @@
|
||||
<td></td>
|
||||
<td>current refresh rate</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.graphics().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
controllers: [
|
||||
{
|
||||
vendor: 'Intel',
|
||||
model: 'Intel Iris Plus Graphics 655',
|
||||
bus: 'Built-In',
|
||||
vram: 1536,
|
||||
vramDynamic: true
|
||||
}
|
||||
],
|
||||
displays: [
|
||||
{
|
||||
vendor: '',
|
||||
model: 'Color LCD',
|
||||
main: true,
|
||||
builtin: false,
|
||||
connection: 'Internal',
|
||||
sizex: -1,
|
||||
sizey: -1,
|
||||
pixeldepth: 24,
|
||||
resolutionx: 2560,
|
||||
resolutiony: 1600,
|
||||
currentResX: 2560,
|
||||
currentResY: 1600,
|
||||
positionX: 0,
|
||||
positionY: 0,
|
||||
currentRefreshRate: -1
|
||||
}
|
||||
]
|
||||
}</pre>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
@ -172,7 +172,8 @@
|
||||
<button class="btn btn-light" onclick="location.href='https://github.com/sebhildebrandt/systeminformation'">View on Github <i class=" fab fa-github"></i></button>
|
||||
</div>
|
||||
<div class="down">
|
||||
Read Documentation<br>
|
||||
<button class="btn btn-primary mb-2" onclick="location.href='https://www.buymeacoffee.com/systeminfo'">Buy me a coffee <i class="far fa-mug-hot"></i></button>
|
||||
<br>Read Documentation<br>
|
||||
<i class="fal fa-caret-down caret"></i>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
89
docs/os.html
89
docs/os.html
@ -205,6 +205,29 @@
|
||||
<td></td>
|
||||
<td>OS uses UEFI on startup</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.osInfo().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
platform: 'darwin',
|
||||
distro: 'Mac OS X',
|
||||
release: '10.15.3',
|
||||
codename: 'macOS Catalina',
|
||||
kernel: '19.3.0',
|
||||
arch: 'x64',
|
||||
hostname: 'hostname.local',
|
||||
codepage: 'UTF-8',
|
||||
logofile: 'apple',
|
||||
serial: 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
|
||||
build: '19D76',
|
||||
servicepack: '',
|
||||
uefi: true
|
||||
}</pre>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>si.uuid(cb)</td>
|
||||
<td>{...}</td>
|
||||
@ -525,6 +548,46 @@
|
||||
<td>X</td>
|
||||
<td>virtualbox version</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.versions().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
kernel: '19.3.0',
|
||||
openssl: '1.1.1d',
|
||||
systemOpenssl: '2.8.3',
|
||||
systemOpensslLib: 'LibreSSL',
|
||||
node: '13.8.0',
|
||||
v8: '7.9.317.25-node.28',
|
||||
npm: '6.13.6',
|
||||
yarn: '',
|
||||
pm2: '',
|
||||
gulp: '',
|
||||
grunt: '',
|
||||
git: '2.21.1',
|
||||
tsc: '3.7.5',
|
||||
mysql: 'gpl)',
|
||||
redis: '',
|
||||
mongodb: '',
|
||||
apache: '2.4.41 (Unix)',
|
||||
nginx: '',
|
||||
php: '7.3.11',
|
||||
docker: '19.03.5',
|
||||
postfix: '3.2.2',
|
||||
postgresql: '12.1',
|
||||
perl: '5.18.4',
|
||||
python: '2.7.16',
|
||||
python3: '3.7.3',
|
||||
pip: '',
|
||||
pip3: '19.0.3',
|
||||
java: '',
|
||||
gcc: '4.2.1',
|
||||
virtualbox: ''
|
||||
}</pre>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>si.users(cb)</td>
|
||||
<td>[{...}]</td>
|
||||
@ -595,6 +658,32 @@
|
||||
<td>X</td>
|
||||
<td>last command or shell</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.users().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
[
|
||||
{
|
||||
user: 'yourname',
|
||||
tty: 'ttys006',
|
||||
date: '2020-02-01',
|
||||
time: '21:20',
|
||||
ip: '',
|
||||
command: 'w -ih'
|
||||
},
|
||||
{
|
||||
user: 'othername',
|
||||
tty: 'ttys008',
|
||||
date: '2020-02-01',
|
||||
time: '21:20',
|
||||
ip: '',
|
||||
command: '-bash'
|
||||
}
|
||||
]</pre>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
@ -289,7 +289,7 @@ si.baseboard().then(data => console.log(data));</code></pre class="example">
|
||||
version: '',
|
||||
serial: 'C80-xxxxxxxxxxx',
|
||||
assetTag: ''
|
||||
} </pre>
|
||||
}</pre>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>si.chassis(cb)</td>
|
||||
@ -386,8 +386,7 @@ si.chassis().then(data => console.log(data));</code></pre class="example">
|
||||
serial: 'C01xxxxxxxx',
|
||||
assetTag: 'Mac-99878xxxx...',
|
||||
sku: ''
|
||||
}
|
||||
</pre>
|
||||
}</pre>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
@ -74,6 +74,10 @@
|
||||
"type": "git",
|
||||
"url": "https://github.com/sebhildebrandt/systeminformation.git"
|
||||
},
|
||||
"funding": {
|
||||
"type": "Buy me a coffee",
|
||||
"url": "https://www.buymeacoffee.com/systeminfo"
|
||||
},
|
||||
"os": [
|
||||
"darwin",
|
||||
"linux",
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user