Skip to content

Commit 3ca98cc

Browse files
committed
new readme
1 parent 1ed4d82 commit 3ca98cc

File tree

1 file changed

+30
-5
lines changed

1 file changed

+30
-5
lines changed

README.md

+30-5
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Dependencies:
1616
PLP-SystemInfo is available as a [NuGet Package](https://www.nuget.org/packages/PLP-SystemInfo)
1717

1818
# Documentation
19-
The package contains in the namespace ``PLP_SystemInfo`` two classes for reading system information, ``SystemInfo`` and ``ComponentInfo``,
20-
these classes contain different methods for reading system information.
19+
The package contains in the namespace ``PLP_SystemInfo`` one class for reading system information, ``SystemInfo.cs`` and 3 more namespaces: ``Collections``, ``ComponentInfo`` and ``Models``,
20+
The namespaces ``Collections`` and ``Models`` are largely ignored for use. They only provide the corresponding classes for the outputs.
2121

2222
## PLP_SystemInfo.SystemInfo
2323
The class ``SystemInfo`` contains mainly methods to read general system values.
@@ -44,22 +44,41 @@ Color c = SystemInfo.GetAccentColor();
4444

4545
## PLP_SystemInfo.ComponentInfo.*
4646
The namespace ``PLP_SystemInfo.ComponentInfo`` contains different classes to read out the most important PC components.
47-
Again, each method has a return value for simple usage.
4847

48+
### BoardInfo.cs
4949
```cs
5050
using PLP_SystemInfo.ComponentInfo;
51+
using PLP_SystemInfo.Models;
5152

5253
Board b = BoardInfo.GetMotherboard();
5354
// Returns an object of type **Board** with manufacturer and model.
5455
5556
BIOS bios = BoardInfo.GetBIOSInfo();
5657
// Returns an object of type **BIOS** with manufacturer and version.
58+
```
59+
60+
61+
### OSInfo.cs
62+
```cs
63+
using PLP_SystemInfo.ComponentInfo;
5764

5865
string os = OSInfo.GetOperatingSystemInfo();
5966
// Returns a string with OS name and architecture.
67+
```
68+
69+
### ProcessorInfo.cs
70+
```cs
71+
using PLP_SystemInfo.ComponentInfo;
72+
using PLP_SystemInfo.Collections;
6073

6174
ProcessorCollection processors = ProcessorInfo.GetProcessors();
6275
// Returns a collection of type **Processor** containing information such as name, architecture, cores, threads, cache and clock speed.
76+
```
77+
78+
### RamInfo.cs
79+
```cs
80+
using PLP_SystemInfo.ComponentInfo;
81+
using PLP_SystemInfo.Collections;
6382

6483
RamCollection ram = RamInfo.GetRamInfo();
6584
// Returns a collection of type **RAM** containing information for each installed ram module such as manufacturer, frequency, voltage and capacity.
@@ -78,16 +97,22 @@ double d3 = RamInfo.GetRamInUse();
7897
7998
double d4 = RamInfo.GetAvailableRam();
8099
// Returns the available ram.
100+
```
101+
102+
### GraphicsInfo.cs
103+
```cs
104+
using PLP_SystemInfo.ComponentInfo;
105+
using PLP_SystemInfo.Collections;
81106

82107
GraphicsCollection graphics = GraphicsInfo.GetGraphicscardInfo();
83108
// Returns a collection of type **GraphicsCard** containing information such as name and driver version.
84109
```
85110

86111
To get the information from the collections, simply use a foreach loop, e.g:
87112
```cs
88-
foreach (var item in ram) //ram is a **RamCollection** from the example above
113+
foreach (var item in <yourCollection>)
89114
{
90-
Console.WriteLine(item.Manufacturer);
115+
Console.WriteLine(item.<Property>);
91116
}
92117
```
93118

0 commit comments

Comments
 (0)