diff --git a/README.md b/README.md index e45a02e..3fbe828 100644 --- a/README.md +++ b/README.md @@ -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 -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.