diff --git a/README.md b/README.md index e324615..25ba3ed 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,31 @@ -# awesome-powershell -A curated list of delightful PowerShell modules and resources +# Awesome PowerShell + +> A curated list of delightful PowerShell [packages](#modules) and [resources](#resources). + +Inspired by the [awesome](https://github.com/sindresorhus/awesome) list thing. + +## Modules + +### Security + +- [File System Security](https://gallery.technet.microsoft.com/scriptcenter/1abd77a5-9c0b-4a2b-acef-90dbb2b84e85) - Allows a much easier management of permissions on files and folders using PowerShell. + +## Resources + +# Contribution Guidelines + +Please ensure your pull request adheres to the following guidelines: + +- Search previous suggestions before making a new one, as yours may be a duplicate. +- Suggested packages should be tested and documented. +- Make an individual pull request for each suggestion. +- Use the following format: `[package](link) - Description.` +- New categories, or improvements to the existing categorization are welcome. +- Keep descriptions short and simple, but descriptive. +- Don't mention `Node.js` in the description as it's implied. +- Start the description with a capital and end with a full stop/period. +- Check your spelling and grammar. +- Make sure your text editor is set to remove trailing whitespace. +- The pull request should have a useful title and include a link to the package and why it should be included. + +Thank you for your suggestions!