updated docs v4, v5

This commit is contained in:
Sebastian Hildebrandt 2021-01-25 21:27:12 +01:00
parent 81de749f54
commit b3630ad717
11 changed files with 30 additions and 13 deletions

View File

@ -30,7 +30,7 @@
[![Sponsoring][sponsor-badge]][sponsor-url] [![Sponsoring][sponsor-badge]][sponsor-url]
[![MIT license][license-img]][license-url] [![MIT license][license-img]][license-url]
This is amazing. Started as a small project just for myself, it now has > 10,000 lines of code, > 350 versions published, up to 3 mio downloads per month, > 25 mio downloads overall. Thank you to all who contributed to this project! This is amazing. Started as a small project just for myself, it now has > 10,000 lines of code, > 380 versions published, up to 3 mio downloads per month, > 30 mio downloads overall. Thank you to all who contributed to this project!
## New Version 5.0 ## New Version 5.0
@ -56,7 +56,7 @@ I did a lot of testing on different platforms and machines but of course there m
## Quick Start ## Quick Start
Lightweight collection of 45+ functions to retrieve detailed hardware, system and OS information. Lightweight collection of 50+ functions to retrieve detailed hardware, system and OS information.
- simple to use - simple to use
- get detailed information about system, cpu, baseboard, battery, memory, disks/filesystem, network, docker, software, services and processes - get detailed information about system, cpu, baseboard, battery, memory, disks/filesystem, network, docker, software, services and processes

View File

@ -184,7 +184,7 @@
<div class="row"> <div class="row">
<div class="col-12 sectionheader index"> <div class="col-12 sectionheader index">
<div class="title">Overview</div> <div class="title">Overview</div>
<div class="subtitle">Node.js system information package. Lightweight collection of 45+ functions to retrieve detailed hardware, system and OS information. For Linux, macOS, partial Windows, FreeBSD, OpenBSD, NetBSD and SunOS 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 and SunOS support. Dependency free.</div>
<div class="npmicons"> <div class="npmicons">
<a href="https://npmjs.org/package/systeminformation" rel="nofollow"><img src="https://camo.githubusercontent.com/df25636cbefadf18ca1532e3bdcd0d2794235e19/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f73797374656d696e666f726d6174696f6e2e7376673f7374796c653d666c61742d737175617265" alt="NPM Version" data-canonical-src="https://img.shields.io/npm/v/systeminformation.svg?style=flat-square" style="max-width:100%;"></a> <a href="https://npmjs.org/package/systeminformation" rel="nofollow"><img src="https://camo.githubusercontent.com/df25636cbefadf18ca1532e3bdcd0d2794235e19/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f73797374656d696e666f726d6174696f6e2e7376673f7374796c653d666c61742d737175617265" alt="NPM Version" data-canonical-src="https://img.shields.io/npm/v/systeminformation.svg?style=flat-square" style="max-width:100%;"></a>
<a href="https://david-dm.org/sebhildebrandt/systeminformation" rel="nofollow"><img src="https://camo.githubusercontent.com/69739c043c2be3a38545f105b89381a2a6310f59/68747470733a2f2f696d672e736869656c64732e696f2f64617669642f73656268696c64656272616e64742f73797374656d696e666f726d6174696f6e2e7376673f7374796c653d666c61742d737175617265" alt="deps status" data-canonical-src="https://img.shields.io/david/sebhildebrandt/systeminformation.svg?style=flat-square" style="max-width:100%;"></a> <a href="https://david-dm.org/sebhildebrandt/systeminformation" rel="nofollow"><img src="https://camo.githubusercontent.com/69739c043c2be3a38545f105b89381a2a6310f59/68747470733a2f2f696d672e736869656c64732e696f2f64617669642f73656268696c64656272616e64742f73797374656d696e666f726d6174696f6e2e7376673f7374796c653d666c61742d737175617265" alt="deps status" data-canonical-src="https://img.shields.io/david/sebhildebrandt/systeminformation.svg?style=flat-square" style="max-width:100%;"></a>
@ -224,7 +224,7 @@
<div class="subtitle">Detailed documentation and reference for version 5.x.x</div> <div class="subtitle">Detailed documentation and reference for version 5.x.x</div>
<div class="title-small">Breaking Changes - Version 5</div> <div class="title-small">Breaking Changes - Version 5</div>
<div class="text">We made a lot of improvements and changes in the new version. <span class="bold">Version 5 is NOT fully backward compatible to version 4!</span> Be aware, there are some breaking changes. Please refer to the <a href="changes.html">Version 5 - Changes</a> page to see a full documentation of all changes you should have a look on.</div> <div class="text">We made a lot of improvements and changes in the new version. <span class="bold">Version 5 is NOT fully backward compatible to version 4!</span> Be aware, there are some breaking changes. Please refer to the <a href="changes.html">Version 5 - Changes</a> page to see a full documentation of all changes you should have a look on.</div>
<div class="text"><span class="bold">Version 4 documentation</span> can be found <a href="v4/index.html">here</a>.</div> <div class="text larger"><span class="bold">Version 4 documentation</span> can be found <a href="v4/index.html">here</a>.</div>
</div> </div>
</div> </div>
<div class="row index"> <div class="row index">

View File

@ -569,6 +569,10 @@ h1, h2, h3, h4 {
text-align: center; text-align: center;
} }
.index .larger {
font-size: 1.2rem;
}
.index a { .index a {
text-decoration: none; text-decoration: none;
} }

File diff suppressed because one or more lines are too long

View File

@ -380,6 +380,10 @@ h1, h2, h3, h4 {
.text, .subtitle, .title, .title-small, .npmicons { .text, .subtitle, .title, .title-small, .npmicons {
text-align: center; text-align: center;
} }
.larger {
font-size: 1.2rem;
}
a { a {
text-decoration: none; text-decoration: none;
&:hover { &:hover {

View File

@ -167,8 +167,9 @@
<div class="container"> <div class="container">
<a href="security.html" class="recommendation">Security advisory:<br>Update to v4.31.1</a> <a href="security.html" class="recommendation">Security advisory:<br>Update to v4.31.1</a>
<img class="logo" src="assets/logo.png"> <img class="logo" src="assets/logo.png">
<div class="title">systeminformation</div> <div class="title">systeminformation </div>
<div class="subtitle"><span id="typed"></span></div> <div class="subtitle"><span id="typed"></span>&nbsp;</div>
<div class="version larger">Version 4 documentation</div>
<div class="version">Current Version: <span id="version">4.34.9</span></div> <div class="version">Current Version: <span id="version">4.34.9</span></div>
<button class="btn btn-light" onclick="location.href='https://github.com/sebhildebrandt/systeminformation'">View on Github <i class=" fab fa-github"></i></button> <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>

View File

@ -667,4 +667,9 @@ footer .badge {
color: #fff; color: #fff;
font-size: 0.9rem; font-size: 0.9rem;
} }
.larger {
margin-top: 10px;
font-size: 1.5rem !important;
}
/*# sourceMappingURL=styles.css.map */ /*# sourceMappingURL=styles.css.map */

File diff suppressed because one or more lines are too long

View File

@ -470,3 +470,7 @@ footer {
font-size: 0.9rem; font-size: 0.9rem;
} }
} }
.larger {
margin-top: 10px;
font-size: 1.5rem !important;
}

View File

@ -1,7 +1,6 @@
{ {
"name": "systeminformation", "name": "systeminformation",
"version": "4.34.9", "version": "4.34.9",
"prereleaseversion": "5.0-alpha.0117",
"description": "Simple system and OS information library", "description": "Simple system and OS information library",
"license": "MIT", "license": "MIT",
"author": "Sebastian Hildebrandt <hildebrandt@plus-innovations.com> (https://plus-innovations.com)", "author": "Sebastian Hildebrandt <hildebrandt@plus-innovations.com> (https://plus-innovations.com)",

View File

@ -1,7 +1,7 @@
const readline = require('readline'); const readline = require('readline');
const util = require('util'); const util = require('util');
const exec = require('child_process').exec; const exec = require('child_process').exec;
const lib_version = require('../package.json').prereleaseversion; const lib_version = require('../package.json').version;
const path = require('path'); const path = require('path');
let waiting = false; let waiting = false;
@ -32,8 +32,8 @@ function printMenu() {
} }
function EnableUserInput() { function EnableUserInput() {
readline.emitKeypressEvents(process.stdin); readline.emitKeypressEvents(process.stdin);
process.stdin.setRawMode(true); process.stdin.setRawMode(true);
} }
function dot() { function dot() {
@ -69,7 +69,7 @@ function printTitle(title) {
process.stdin.on('keypress', (key, data) => { process.stdin.on('keypress', (key, data) => {
// console.log(data); // console.log(data);
if (data.name === 'q' && !data.shift) { if (data.name === 'q' && !data.shift) {
// shut down // shut down
process.exit(); process.exit();
} }