aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPowerShellMafia <PowerShellMafia@users.noreply.github.com>2015-12-16 15:24:18 -0800
committerPowerShellMafia <PowerShellMafia@users.noreply.github.com>2015-12-16 15:24:18 -0800
commit70f25c90e2899e85f64a489a887cfb454c357d7a (patch)
treef620382df59173bec3215e189c5b7603017bfb93 /README.md
parent1cdad586c841b34c4681cd30bf2b7a10151e2d21 (diff)
downloadPowerSploit-70f25c90e2899e85f64a489a887cfb454c357d7a.tar.gz
PowerSploit-70f25c90e2899e85f64a489a887cfb454c357d7a.zip
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 11 insertions, 4 deletions
diff --git a/README.md b/README.md
index bb46a98..eaf000a 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,5 @@
### PowerSploit is a collection of Microsoft PowerShell modules that can be used to aid penetration testers during all phases of an assessment. PowerSploit is comprised of the following modules and scripts:
-### Note: All reverse engineering components of PowerSploit now reside in the [PowerShellArsenal](https://github.com/mattifestation/PowerShellArsenal).
-
## CodeExecution
**Execute code on a target machine.**
@@ -92,7 +90,7 @@ Copies a file from an NTFS partitioned volume by reading the raw volume and pars
#### `Invoke-Mimikatz`
-Reflectively loads Mimikatz 1.0 in memory using PowerShell. Can be used to dump credentials without writing anything to disk. Can be used for any functionality provided with Mimikatz.
+Reflectively loads Mimikatz 2.0 in memory using PowerShell. Can be used to dump credentials without writing anything to disk. Can be used for any functionality provided with Mimikatz.
#### `Get-Keystrokes`
@@ -197,6 +195,15 @@ For help on each individual command, Get-Help is your friend.
Note: The tools contained within this module were all designed such that they can be run individually. Including them in a module simply lends itself to increased portability.
+## Contribution Rules
+
+We need contributions! If you have a great idea for PowerSploit, we'd love to add it. New additions will require the following:
+
+* The script must adhere to the style guide. Any exceptions to the guide line would need an explicit, valid reason.
+* The module manifest needs to be updated to reflect the new function being added.
+* A brief description of the function should be added to this README.md
+* Pester tests must accompany all new functions. See the Tests folder for examples but we are looking for tests that at least cover the basics by testing for expected/unexpected input/output and that the function exhibits desired functionality. Make sure the function is passing all tests (preferably in mutiple OSes) prior to submitting a pull request. Thanks!
+
## Script Style Guide
**For all contributors and future contributors to PowerSploit, I ask that you follow this style guide when writing your scripts/modules.**
@@ -238,4 +245,4 @@ Note: The tools contained within this module were all designed such that they ca
* Use default values for your parameters when it makes sense. Ideally, you want a script that will work without requiring any parameters.
-* If a script creates complex custom objects, include a ps1xml file that will properly format the object's output. \ No newline at end of file
+* If a script creates complex custom objects, include a ps1xml file that will properly format the object's output.