Skip to content

Commit 7b9757e

Browse files
Standardize README landing page
1 parent d2463d2 commit 7b9757e

1 file changed

Lines changed: 6 additions & 28 deletions

File tree

README.md

Lines changed: 6 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
11
# Net
22

3-
Net is a PowerShell module for inspecting network configuration data from PowerShell.
4-
5-
## Prerequisites
6-
7-
- PowerShell with `Microsoft.PowerShell.PSResourceGet` available for `Install-PSResource`.
8-
- The [PSModule framework](https://github.com/PSModule) is used for building, testing, and publishing the module.
3+
Net is a PowerShell module for network-related functions.
94

105
## Installation
116

@@ -16,34 +11,17 @@ Install-PSResource -Name Net
1611
Import-Module -Name Net
1712
```
1813

19-
## Commands
20-
21-
- `Get-NetIPConfiguration` retrieves network interface IP configuration, including addresses, prefix lengths, gateways, and DNS servers.
22-
23-
## Usage
24-
25-
List IP configuration for all interfaces:
26-
27-
```powershell
28-
Get-NetIPConfiguration
29-
```
30-
31-
List active IPv4 configuration only:
14+
## Documentation
3215

33-
```powershell
34-
Get-NetIPConfiguration -InterfaceStatus Up -AddressFamily IPv4
35-
```
16+
Documentation is published at [psmodule.io/Net](https://psmodule.io/Net/).
3617

37-
The command is also available through the `IPConfig` alias:
18+
Use PowerShell help and command discovery for module details:
3819

3920
```powershell
40-
IPConfig -AddressFamily IPv6
21+
Get-Command -Module Net
22+
Get-Help <CommandName> -Examples
4123
```
4224

43-
## Documentation
44-
45-
Command documentation is published at [psmodule.io/Net](https://psmodule.io/Net/).
46-
4725
## Contributing
4826

4927
Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements.

0 commit comments

Comments
 (0)