Skip to content

📖 [Docs]: README pages now use the standard module landing-page format #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
base: main
Choose a base branch
from
Open

📖 [Docs]: README pages now use the standard module landing-page format #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 8 additions & 33 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,52 +1,27 @@
# PublicIP

This is a PowerShell module for getting information about your public IP.
It uses the APIs of [IPInfo](https://ipinfo.io) and [MyIP](https://www.myip.com/) to get this data.

## Prerequisites

This module requires an internet connection to work.
PublicIP is a PowerShell module for getting information about your public IP address.

## Installation

To install the module simply run the following command in a PowerShell terminal.
Install the module from the PowerShell Gallery:

```powershell
Install-PSResource -Name PublicIP
Import-Module -Name PublicIP
```

## Usage

You can use this module to get info about your public IP.

### List information about your public IP and ISP

This command will information about your public IP and more information about your ISP.

```powershell
Get-PublicIP
```
## Documentation

### List public IP using 'MyIP' API
Documentation is published at [psmodule.io/PublicIP](https://psmodule.io/PublicIP/).

This command will get your public IP using the 'MyIP' API.
Use PowerShell help and command discovery for module details:

```powershell
Get-PublicIP -Provider MyIP
Get-Command -Module PublicIP
Get-Help <CommandName> -Examples
```

## Contributing

Coder or not, you can contribute to the project! We welcome all contributions.

### For Users

If you don't code, you still sit on valuable information that can make this project even better. If you experience that the
product does unexpected things, throw errors or is missing functionality, you can help by submitting bugs and feature requests.
Please see the issues tab on this project and submit a new issue that matches your needs.

### For Developers

If you do code, we'd love to have your contributions. Please read the [Contribution guidelines](CONTRIBUTING.md) for more information.
You can either help by picking up an existing issue or submit a new one if you have an idea for a new feature or improvement.
Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements.
Loading