-
Notifications
You must be signed in to change notification settings - Fork 0
📖 [Docs]: README pages now use the standard module landing-page format #16
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.
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
3
commits into
main
Choose a base branch
from
docs/fix-readme-placeholders
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+11
−53
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,69 +1,27 @@ | ||
| # {{ NAME }} | ||
| # Net | ||
|
|
||
| {{ DESCRIPTION }} | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| This uses the following external resources: | ||
| - The [PSModule framework](https://github.com/PSModule/Process-PSModule) for building, testing and publishing the module. | ||
| Net is a PowerShell module for network-related functions. | ||
|
|
||
| ## Installation | ||
|
|
||
| To install the module from the PowerShell Gallery, you can use the following command: | ||
| Install the module from the PowerShell Gallery: | ||
|
|
||
| ```powershell | ||
| Install-PSResource -Name {{ NAME }} | ||
| Import-Module -Name {{ NAME }} | ||
| Install-PSResource -Name Net | ||
| Import-Module -Name Net | ||
| ``` | ||
|
|
||
| ## 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! | ||
| ``` | ||
| ## Documentation | ||
|
|
||
| ### Example 2 | ||
| Documentation is published at [psmodule.io/Net](https://psmodule.io/Net/). | ||
|
|
||
| Provide examples for typical commands that a user would like to do with the module. | ||
| Use PowerShell help and command discovery for module details: | ||
|
|
||
| ```powershell | ||
| Import-Module -Name PSModuleTemplate | ||
| Get-Command -Module Net | ||
| Get-Help -Name 'CommandName' -Examples | ||
| ``` | ||
|
|
||
| ### 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. | ||
|
|
||
| ## 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. | ||
| Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.