diff --git a/README.md b/README.md index 6319793..5df3fb1 100644 --- a/README.md +++ b/README.md @@ -1,69 +1,21 @@ -# {{ NAME }} +# IPv6 -{{ DESCRIPTION }} +IPv6 is intended to be a PowerShell module for managing IPv6 networking. -## Prerequisites +## Status -This uses the following external resources: -- The [PSModule framework](https://github.com/PSModule/Process-PSModule) for building, testing and publishing the module. +This repository is currently a placeholder. The module source currently contains only template scaffold commands used by tests, and those commands are not IPv6-focused public API. -## Installation - -To install the module from the PowerShell Gallery, you can use the following command: - -```powershell -Install-PSResource -Name {{ NAME }} -Import-Module -Name {{ NAME }} -``` - -## Usage - -Here is a list of example that are typical use cases for the module. - -### Example 1: Greet an entity - -Provide examples for typical commands that a user would like to do with the module. - -```powershell -Greet-Entity -Name 'World' -Hello, World! -``` - -### Example 2 - -Provide examples for typical commands that a user would like to do with the module. +No supported IPv6-focused commands or usage examples are available yet. The module is not ready for general installation; contributors can run the repository tests locally with Pester while implementation work is pending: ```powershell -Import-Module -Name PSModuleTemplate +Invoke-Pester ``` -### Find more examples - -To find more examples of how to use the module, please refer to the [examples](examples) folder. - -Alternatively, you can use the Get-Command -Module 'This module' to find more commands that are available in the module. -To find examples of each of the commands you can use Get-Help -Examples 'CommandName'. - ## Documentation -Link to further documentation if available, or describe where in the repository users can find more detailed documentation about -the module's functions and features. +When this module is implemented, command details should live in PowerShell help and generated documentation rather than being duplicated in this README. ## 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. - -## Acknowledgements - -Here is a list of people and projects that helped this project in some way. +Design discussion issues are welcome now. Please wait to open implementation pull requests until module development begins.