summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDavid Knaack <davidkna@users.noreply.github.com>2021-07-04 21:32:58 +0200
committerGitHub <noreply@github.com>2021-07-04 15:32:58 -0400
commitcea1a1ceb1636b8941b3c8e7bdd8d6284d737281 (patch)
tree15d66f02b8c0721717f60728cdf37fea837142eb /docs
parent196cc8aa3980d67e8ddb0d80bbdd92720adc0aec (diff)
feat: add support for nu shell (#2847)
Diffstat (limited to 'docs')
-rw-r--r--docs/README.md17
-rw-r--r--docs/config/README.md6
2 files changed, 20 insertions, 3 deletions
diff --git a/docs/README.md b/docs/README.md
index accda4783..22ab3f012 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -129,3 +129,20 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
eval `starship init tcsh`
```
+
+ #### Nushell
+
+ ::: warning
+ This will change in the future.
+ Only nu version v0.33 or higher is supported.
+ :::
+ Add the following to your nu config file:
+
+ ```toml
+ startup = [
+ "mkdir ~/.cache/starship",
+ "starship init nu | save ~/.cache/starship/init.nu",
+ "source ~/.cache/starship/init.nu"
+ ]
+ prompt = "starship_prompt"
+ ```
diff --git a/docs/config/README.md b/docs/config/README.md
index 522b3d9bb..b7d62422f 100644
--- a/docs/config/README.md
+++ b/docs/config/README.md
@@ -413,7 +413,7 @@ look at [this example](#with-custom-error-shape).
::: warning
-`error_symbol` is not supported on elvish shell.
+`error_symbol` is not supported on elvish and nu shell.
:::
@@ -1487,7 +1487,7 @@ then the module will also show when there are 0 jobs running.
::: warning
-This module is not supported on tcsh.
+This module is not supported on tcsh and nu.
:::
@@ -2624,7 +2624,7 @@ To enable it, set `disabled` to `false` in your configuration file.
:::
::: warning
-This module is not supported on elvish shell.
+This module is not supported on elvish and nu shell.
:::
### Options