Skip to content

Commit

Permalink
Improve writing
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgebucaran authored Nov 17, 2020
1 parent 68d10da commit 8015282
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# fish-async-prompt

Make your prompt asynchronous in Fish shell.
Make your prompt asynchronous in [Fish](https://fishshell.com/).

## Description

![Demo Video](demo.png)

It runs `fish_prompt` and `fish_right_prompt` functions as another process and then, update the prompt asynchronously.
We run your `fish_prompt` and `fish_right_prompt` functions as a separate process to update your prompt asynchronously.

## Installation

Expand All @@ -16,24 +16,26 @@ With [Fisher](https://github.com/jorgebucaran/fisher):
$ fisher install acomagu/fish-async-prompt
```

If your prompt doesn't work correctly, try changing the configuration.

## Configuration

### Variable: `async_prompt_inherit_variables`
### `async_prompt_inherit_variables`

Define variables inherited to prompt functions. Set `all` to pass all global variables.

**Default:** `status SHLVL CMD_DURATION`

### Variable: `async_prompt_functions`
### `async_prompt_functions`

Define functions replaced to run asynchronously. Usually one or both of `fish_prompt` and `fish_right_prompt`.

Other functions can be specified, but they must be called from `fish_prompt` or `fish_right_prompt` and arguments can't be passed.
Other functions can be specified, but they must be called from `fish_prompt` or `fish_right_prompt` and function arguments can't be passed to it.

**Default:** `fish_prompt fish_right_prompt`

## Author

- [acomagu](https://github.com/acomagu)

## License

[MIT](LICENSE.md)

0 comments on commit 8015282

Please sign in to comment.