mike/systeminformation
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

v5 docs update

Browse Source
This commit is contained in:
Sebastian Hildebrandt 2021-01-25 20:47:11 +01:00
parent dae9b9348c
commit 664b07abcc
3 changed files with 34 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -30,6 +30,7 @@ For major (breaking) changes - version 3 and 2 see end of page.
| Version | Date | Comment |
| -------------- | -------------- | -------- |
| 5.0.9 | 2020-01-26 | new version 5 release |
| 4.34.9 | 2020-01-25 | `graphics()` virtual controller vram value fix (win) |
| 4.34.8 | 2020-01-25 | `graphics()` controller subDeviceId fix (win) |
| 4.34.7 | 2020-01-13 | `services()` improved service discovery (linux) |

59
README.md
View File

@ -30,44 +30,29 @@
[![Sponsoring][sponsor-badge]][sponsor-url]
[![MIT license][license-img]][license-url]
#### Happy new year
```
.''.
.''. . *''* :_\/_: .
:_\/_: _\(/_ .:.*_\/_* : /\ : .'.:.'.
.''.: /\ : ./)\ ':'* /\ * : '..'. -=:o:=-
:_\/_:'.:::. ' *''* * '.\'/.' _\(/_'.':'.'
: /\ : ::::: *_\/_* -= o =- /)\ ' *
'..' ':::' * /\ * .'/.\'. '
* *..* :
*
```
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!
## Upcoming
## New Version 5.0
**MacOS on ARM (Apple silicon support), Windows on ARM**: New Apple M1 silicon hardware just arrived (any support is highly appreciated - [Buy me a coffee](https://www.buymeacoffee.com/systeminfo)). We already made a lot of tests and improvements to support Apple M1 silicon. Current status [is documented here](https://github.com/sebhildebrandt/systeminformation/issues/453).
The new Version 5 is here - I spend several weeks finalizing this new version. Any support is highly appreciated - [Buy me a coffee](https://www.buymeacoffee.com/systeminfo)
**Version 5**: we are planning a new major version with some minor breaking changes and some additional features. Will try to make this available Q1 of 2021.
This next major version release 5.0 comes with several optimizations and changes (some of them are breaking changes!):
## New Version 4.0
This next major version release 4.0 comes with several optimizations and changes:
- new systeminformation website with better documentation and examples [systeminformation.io][systeminformation-url]
- added typescript definitions
- reworked network section: this will now return more information and allows getting networkStats for more than one interface at once.
- dockerContainerStats for multiple containers or all containers at once
- optimized graphics controller and display detection
- added wifiNetworks to get available Wi-Fi networks
- added vboxInfo to get detailed vm information
- added chassis information
- added bluetooth: get detailed bluetooth device information
- added usb: get detailed usb controller and device information
- added printer: get information from detected printers
- added audio: get detailed audio device information
- better uuid function to get unique hardware and os UUIDs
- better/extended cpu info detection
- better/extended system info detection
- Apple Silicon M1 support
- better Raspberry-PI detection
- systeminformation website updated and extendet with full documentation and examples [systeminformation.io][systeminformation-url]
- lot of minor improvements
Breaking Changes in version 4: you will see some minor breaking changes. Read the [detailed changelog][changelog-url].
Breaking Changes in version 5: you will see several breaking changes for the sake of a more consistent API interface and to be future proof. Read the [detailed Version 5 changes][changes5-url].
I did a lot of testing on different platforms and machines but of course there might be some issues that I am not aware of. I would be happy if you inform me when you discover any issues. Issues can be [opened here][new-issue].
## Quick Start
@ -86,6 +71,15 @@ Lightweight collection of 45+ functions to retrieve detailed hardware, system an
$ npm install systeminformation --save
```
#### Still need Version 4?
If you need the lates version 4 release of the package (for compatibility reasons), you can install version 4 (latest release) with
```bash
$ npm install systeminformation@4 —save
```
### Usage
All functions (except `version` and `time`) are implemented as asynchronous functions. Here a small example how to use them:
@ -107,13 +101,13 @@ si.cpu()
(last 7 major and minor version releases)
- Version 5.0.0: new version 5 - attention there are some breaking changes. See [detailed version 5 changes here][changes5-url].
- Version 4.34.0: `system()` added flag virtual (linux, windows)
- Version 4.33.0: `graphics()` added nvidia-smi support (linux, windows)
- Version 4.32.0: `graphics()` added clinfo support (linux)
- Version 4.31.0: `osInfo()` added FQDN
- Version 4.30.0: `get()` added possibility to provide parameters
- Version 4.29.0: `fsSize()` correct fs type detection macOS (HFS, APFS, NFS)
- Version 4.28.0: `graphics()` added deviceName (Windows)
- ...
You can find all changes here: [detailed changelog][changelog-url]
@ -968,6 +962,7 @@ All other trademarks are the property of their respective owners.
[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
[changelog-url]: https://github.com/sebhildebrandt/systeminformation/blob/master/CHANGELOG.md
[changes5-url]: https://systeminformation.io/changes.html
[caretaker-url]: https://github.com/sebhildebrandt
[caretaker-image]: https://img.shields.io/badge/caretaker-sebhildebrandt-blue.svg?style=flat-square
@ -983,6 +978,8 @@ All other trademarks are the property of their respective owners.
[closed-issues-img]: https://img.shields.io/github/issues-closed-raw/sebhildebrandt/systeminformation.svg?style=flat-square&color=brightgreen
[closed-issues-url]: https://github.com/sebhildebrandt/systeminformation/issues?q=is%3Aissue+is%3Aclosed
[new-issue]: https://github.com/sebhildebrandt/systeminformation/issues/new/choose
[mmon-npm-url]: https://npmjs.org/package/mmon
[mmon-github-url]: https://github.com/sebhildebrandt/mmon

14
docs/index.html
View File

@ -169,14 +169,9 @@
<a href="security.html" class="recommendation">Security advisory:<br>Update to v4.31.1</a>
<img class="logo" src="assets/logo.png">
<div class="title">systeminformation</div>
<<<<<<< HEAD <div class="subtitle"><span id="typed"></span>
</div>
<div class="version">Current Version: <span id="version">4.34.9</span></div>
=======
<div class="subtitle"><span id="typed"></span>&nbsp;</div>
<div class="version">Current Version: <span id="version">4.34.4</span></div>
>>>>>>> Website new design v5
<button class="btn btn-light" onclick="location.href='https://github.com/sebhildebrandt/systeminformation'">View on Github <i class=" fab fa-github"></i></button>
<div class="subtitle"><span id="typed"></span>&nbsp;</div>
<div class="version">New Version: <span id="version">5.0.0</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>
</div>
<div class="down">
<button class="btn btn-primary mb-2" onclick="location.href='https://www.buymeacoffee.com/systeminfo'">Buy me a coffee&nbsp;&nbsp;<i class="far fa-mug-hot"></i></button>
@ -206,7 +201,7 @@
</div>
<div class="row number-section">
<div class="col-xl-4 col-lg-4 col-md-4 col-12">
<div class="numbers">10,943</div>
<div class="numbers">12,898</div>
<div class="title">Lines of code</div>
</div>
<div class="col-xl-4 col-lg-4 col-md-4 col-12">
@ -229,6 +224,7 @@
<div class="subtitle">Detailed documentation and reference for version 5.x.x</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"><span class="bold">Version 4 documentation</span> can be found <a href="v4/index.html">here</a>.</div>
</div>
</div>
<div class="row index">