summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKoichi Murase <myoga.murase@gmail.com>2024-02-08 23:16:19 +0900
committerGitHub <noreply@github.com>2024-02-08 14:16:19 +0000
commite2f080ccff59f3b6b7112092531f6f060f85aaa2 (patch)
treedbb092f4954c0e34e548637df571652e86c47ed3
parent8460210202af4e48ea55c997bf2739a6f0570e4a (diff)
docs(README): clarify prerequisites for Bash (#1686)
* docs(README): clarify prerequisites for Bash https://github.com/atuinsh/atuin/discussions/1683 * docs(README): fix grammar
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index dff561e2..5d9de09e 100644
--- a/README.md
+++ b/README.md
@@ -266,7 +266,7 @@ antigen bundle atuinsh/atuin@main
### bash
-Atuin works in `bash >= 3.1`, but we recommend to use Atuin with the recent versions of `bash >= 5`.
+Atuin works in `bash >= 3.1` when combined with either ble.sh or bash-preexec. We recommend to use Atuin with the recent versions of `bash >= 5`.
#### [ble.sh](https://github.com/akinomyoga/ble.sh)
@@ -291,7 +291,7 @@ curl https://raw.githubusercontent.com/rcaloras/bash-preexec/master/bash-preexec
echo '[[ -f ~/.bash-preexec.sh ]] && source ~/.bash-preexec.sh' >> ~/.bashrc
```
-Then setup Atuin
+Then set up Atuin
```bash
echo 'eval "$(atuin init bash)"' >> ~/.bashrc