technofab/pay-respects
1
0
Fork 0
mirror of https://github.com/TECHNOFAB11/pay-respects.git synced 2025-12-11 22:10:09 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: update README

Browse source
This commit is contained in:
iff 2023-08-08 22:20:49 +02:00
parent 7ff068236d
commit a8f250b3ce
1 changed files with 5 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -30,14 +30,13 @@ eval "$(pay-respects <shell> --alias)"
pay-respects fish --alias | source pay-respects fish --alias | source
# for `nushell`, the alias can be added automatically with: # for `nushell`, the alias can be added automatically with:
# it's however very very broken, not recommended to use right now
pay-respects nushell pay-respects nushell
``` ```
You can now **press `F` to Pay Respects**! You can now **press `F` to Pay Respects**!
Currently, only corrections to `bash`, `zsh`, and `fish` are working flawlessly. Currently, only corrections to `bash`, `zsh`, and `fish` are working flawlessly.
`nushell` is currently usable, but there is no alias expansion and you will have to add the corresponding environment variables manually. `nushell` is currently usable, but there is no alias expansion and you will have to put the evaluated initialization command in your config file (added automatically with `pay-respects nushell`).
## Installing ## Installing
@ -73,12 +72,13 @@ pattern = [
] ]
# this will change the first argument to `fix`, while keeping the rest intact # this will change the first argument to `fix`, while keeping the rest intact
suggest = [ suggest = [
"{{command[0]}} fix {{command[2:]}}", '''
{{command[0]}} fix {{command[2:]}} '''
] ]
[[match_err]] [[match_err]]
pattern = [ pattern = [
"pattern 1", "pattern 1"
] ]
# this will add a `sudo` before the command if: # this will add a `sudo` before the command if:
# - the `sudo` is found by `command -v` # - the `sudo` is found by `command -v`
@ -86,8 +86,7 @@ pattern = [
suggest = [ suggest = [
''' '''
#[executable(sudo), !cmd_contains(sudo)] #[executable(sudo), !cmd_contains(sudo)]
sudo {{command}} sudo {{command}} '''
'''
] ]
``` ```