You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 23, 2021. It is now read-only.
From my perspective, every module (whether you house it on GitHub, an internal system, anywhere) should have a README.md to at the very least, provide:
What is this
Prerequisites
How to install
Example(s) of common scenario(s)
Also... less critical, but potentially helpful, you might consider some basic simple format folks can start from (perhaps including a common install/discovery snippet with Install-Module ModuleName, Get-Help about_ModuleName, Get-Command -Module ModuleName`, etc.
Hi!
From my perspective, every module (whether you house it on GitHub, an internal system, anywhere) should have a README.md to at the very least, provide:
Also... less critical, but potentially helpful, you might consider some basic simple format folks can start from (perhaps including a common install/discovery snippet with
Install-Module ModuleName,Get-Help about_ModuleName, Get-Command -Module ModuleName`, etc.Cheers!