diff --git a/README.md b/README.md index a69f30d..a190887 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ +

+ PSCommandHelper — type rm -rf ./build, get Remove-Item -Recurse -Force +

+ # PSCommandHelper > Learn PowerShell by doing. When you type a bash command that doesn't work in PowerShell, PSCommandHelper suggests the PowerShell equivalent — with an explanation. diff --git a/assets/hero-animated.svg b/assets/hero-animated.svg new file mode 100644 index 0000000..487789a --- /dev/null +++ b/assets/hero-animated.svg @@ -0,0 +1,201 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ❯ pwsh + + + + + + + + + + + + + + + + + + + PS + ~/project + > + + + rm -rf ./build + + + + + + + Remove-Item: A parameter cannot be found that matches parameter name 'rf'. + + + ──────────────────────────────────────────────────────────────── + + + 💡 + PSCommandHelper + (alias tip) + + + + You typed: + rm -rf ./build + + + + PS equivalent: + Remove-Item -Recurse -Force + + + Remove-Item deletes files/folders. -Recurse handles + subdirectories, -Force skips confirmation. + + Note: `rm -rf` is already aliased in PS, but the flags differ. + + Example: + + + > + Remove-Item + ./build -Recurse -Force + + + ──────────────────────────────────────────────────────────────── + + + + PS + ~/project + > + + + + + + + diff --git a/assets/hero.png b/assets/hero.png new file mode 100644 index 0000000..bfdf47b Binary files /dev/null and b/assets/hero.png differ diff --git a/assets/hero.svg b/assets/hero.svg new file mode 100644 index 0000000..7d657b6 --- /dev/null +++ b/assets/hero.svg @@ -0,0 +1,145 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ❯ pwsh + + + + + + + + + + + + + + + + + + + + + + + + + + + PS + ~/project + > + rm -rf ./build + + + + Remove-Item: A parameter cannot be found that matches parameter name 'rf'. + + + ──────────────────────────────────────────────────────────────── + + + 💡 + PSCommandHelper + (alias tip) + + + + You typed: + rm -rf ./build + + + + PS equivalent: + Remove-Item -Recurse -Force + + + Remove-Item deletes files/folders. -Recurse handles + subdirectories, -Force skips confirmation. + + Note: `rm -rf` is already aliased in PS, but the flags differ. + + Example: + + > + Remove-Item + ./build -Recurse -Force + + + ──────────────────────────────────────────────────────────────── + + + + PS + ~/project + > + + + + + + + + +