diff --git a/.github/images/card.svg b/.github/images/card.svg new file mode 100644 index 0000000..4e89214 --- /dev/null +++ b/.github/images/card.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/.github/images/license.svg b/.github/images/license.svg new file mode 100644 index 0000000..8990e77 --- /dev/null +++ b/.github/images/license.svg @@ -0,0 +1 @@ +license: Apache-2.0licenselicenseApache-2.0Apache-2.0 \ No newline at end of file diff --git a/.github/images/usage.svg b/.github/images/usage.svg index 8722b0c..b25670a 100644 --- a/.github/images/usage.svg +++ b/.github/images/usage.svg @@ -1,5 +1,5 @@ - - + + path Usage @@ -14,11 +14,12 @@ text { font-family: ui-monospace, 'JetBrains Mono', 'Fira Code', 'Iosevka', SFMono-Regular, 'SF Mono', Menlo, Consolas, 'Liberation Mono', monospace; font-size: 14px; font-display: swap; white-space: pre; } tspan { white-space: pre; } - .bold { font-weight: bold; } - .italic { font-style: italic; } - .underline { text-decoration-line: underline; } - .dim { opacity: 0.75; } - .terminal { font-weight: bold; } + .terminal { font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; font-weight: 500; font-size: 15px; } + + tspan.BB { font-weight: bold; } + tspan.II { font-style: italic; } + tspan.UU { text-decoration-line: underline; } + tspan.DD { opacity: 0.75; } text { fill: #F5F5F5; } .terminal { fill: #DDD; } @@ -30,8 +31,8 @@ tspan.b { fill: #5C9AD8; } tspan.m { fill: #B6419E; } tspan.c { fill: #38AFC5; } - tspan.LG { fill: #AAA; } - tspan.DG { fill: #696969; } + tspan.s { fill: #AAA; } + tspan.d { fill: #696969; } tspan.R { fill: #EF5A56; } tspan.G { fill: #49E471; } tspan.Y { fill: #E3E342; } @@ -44,53 +45,56 @@ - - + + + + + + + - - - + Terminal - Terminal - Usage: path {options} {command} - Commands - base path ............... Strip directory and suffix from filenames - dir path ................ Strip last component from file name - dirn num path ........... Return N elements from path - link path ............... Print resolved symbolic links or canonical file names - clean path .............. Print shortest path name equivalent to path by purely lexical processing - compact path ............ Converts path to compact representation - abs path ................ Print absolute representation of path - ext path ................ Print file extension - match pattern path ...... Filter given path using pattern - join root path .......... Join path elements - add-prefix prefix path .. Add the substring at the beginning - del-prefix prefix path .. Remove the substring at the beginning - add-suffix suffix path .. Add the substring at the end - del-suffix suffix path .. Remove the substring at the end - exclude substr path ..... Exclude part of the string - is-abs path ............. Check if given path is absolute - is-local path ........... Check if given path is local - is-safe path ............ Check if given path is safe - is-match pattern path ... Check if given path is match to pattern - Options - --zero, -z ....... End each output line with NUL, not newline - --space, -s ...... End each output line with space, not newline - --quiet, -q ...... Suppress all error messages - --no-color, -nc .. Disable colors in output - --help, -h ....... Show this help message - --version, -v .... Show version - Examples - path base /path/to/file.txt - → file.txt - path dir /path/to/file.txt - → /path/to - path compact /very/long/path/to/some/file.txt - → /v/l/p/t/s/file.txt - ls -1 | path is-match '*.txt' && echo MATCH! - Check if all files in current directory is match to pattern - PATH_QUIET=1 path dir /path/to/file.txt - Run dir command in quiet mode enabled by environment variable + Usage: path {options} {command} + Commands + base path ............... Strip directory and suffix from filenames + dir path ................ Strip last component from file name + dirn num path ........... Return N elements from path + link path ............... Print resolved symbolic links or canonical file names + clean path .............. Print shortest path name equivalent to path by purely + lexical processing + compact path ............ Converts path to compact representation + abs path ................ Print absolute representation of path + ext path ................ Print file extension + match pattern path ...... Filter given path using pattern + join root path .......... Join path elements + add-prefix prefix path .. Add the substring at the beginning + del-prefix prefix path .. Remove the substring at the beginning + add-suffix suffix path .. Add the substring at the end + del-suffix suffix path .. Remove the substring at the end + exclude substr path ..... Exclude part of the string + is-abs path ............. Check if given path is absolute + is-local path ........... Check if given path is local + is-safe path ............ Check if given path is safe + is-match pattern path ... Check if given path is match to pattern + Options + --zero, -z ....... End each output line with NUL, not newline + --space, -s ...... End each output line with space, not newline + --quiet, -q ...... Suppress all error messages + --no-color, -nc .. Disable colors in output + --help, -h ....... Show this help message + --version, -v .... Show version + Examples + path base /path/to/file.txt + → file.txt + path dir /path/to/file.txt + → /path/to + path compact /very/long/path/to/some/file.txt + → /v/l/p/t/s/file.txt + ls -1 | path is-match '*.txt' && echo MATCH! + Check if all files in current directory is match to pattern + PATH_QUIET=1 path dir /path/to/file.txt + Run dir command in quiet mode enabled by environment variable - + diff --git a/README.md b/README.md index d09d6eb..8281f71 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ - + + @@ -6,7 +7,7 @@ - + Installation • Command-line completion • Man documentation • Usage • CI Status • Contributing • License @@ -110,7 +111,7 @@ path --generate-man | sudo gzip > /usr/share/man/man1/path.1.gz ### Usage - + ### CI Status
+
@@ -6,7 +7,7 @@ - +
Installation • Command-line completion • Man documentation • Usage • CI Status • Contributing • License