aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2021-04-18 08:49:14 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2021-04-18 08:49:14 +0300
commitaf8ea5e97469d64d1e19e7a91a709c703a1ad37d (patch)
tree79f3566d91f295dac2de34a6f70dc10f541443b1
parentREADME: fix badge link (diff)
downloadcleanup-path-af8ea5e97469d64d1e19e7a91a709c703a1ad37d.tar.gz
cleanup-path-af8ea5e97469d64d1e19e7a91a709c703a1ad37d.zip
README: update
-rw-r--r--README.md13
1 files changed, 9 insertions, 4 deletions
diff --git a/README.md b/README.md
index 7e42659..446269c 100644
--- a/README.md
+++ b/README.md
@@ -12,15 +12,20 @@ Use it in your workflow like this:
- name: Clean up PATH
uses: egor-tensin/cleanup-path@v2
+* You can pass additional directory paths to add to PATH using the `dirs`
+parameter.
+* System directories under C:\Windows are added to PATH by default.
+Disable this by setting the `default` parameter to `0`.
+
API
---
| Input | Value | Default | Description
| ------- | ------- | ------- | -----------
-| dirs | *Empty* | Yes | No additional paths.
-| | *Other* | No | Additional paths, separated by a semicolon (;).
-| default | 1 | Yes | Add the default directories under C:\Windows.
-| | *Other* | No | Don't add the default directories.
+| dirs | *Empty* | ✓ | No additional paths.
+| | *Other* | | Additional paths, separated by a semicolon (;).
+| default | 1 | ✓ | Add the default directories under C:\Windows.
+| | *Other* | | Don't add the default directories.
The action sets the PATH environment variable.
Note that even if you call it with `default: 0` and don't specify any `dirs`,