diff --git a/README.md b/README.md index 2cff2f5..17c5cce 100644 --- a/README.md +++ b/README.md @@ -11,3 +11,20 @@ Invoke-AtomicRedTeam is a PowerShell module to execute tests as defined in the [ See the Wiki for complete [Installation and Usage instructions](https://github.com/redcanaryco/invoke-atomicredteam/wiki). Note: This execution frameworks works on Windows, MacOS and Linux. If using on MacOS or Linux you must install PowerShell Core first. + +### Contributing +Ensure proper byte order marks (BOM) are maintained when utilizing a PowerShell linter with the following steps: + +```shell +pip3 install pre-commit +pre-commit install +pre-commit install-hooks +``` + +By following these instructions, pre-commit hooks will be activated, automatically resolving any byte order mark issues within your PowerShell files. Additionally, these hooks will be triggered prior to committing code to your GitHub repository, ensuring consistent formatting and adherence to best practices. + +You can also trigger pre-commit hooks manually by + +```shell +pre-commit run --all-files +``` \ No newline at end of file