summaryrefslogtreecommitdiff
path: root/plugins/starship/README.md
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2023-11-04 18:38:46 -0700
committerTuowen Zhao <ztuowen@gmail.com>2023-11-04 18:38:46 -0700
commit4d908094fdc2a0c0e9a0a072eba213fab7adef43 (patch)
tree7c17e70bcdeebbe96c84d849bdf17882007480d8 /plugins/starship/README.md
parent4b0bbc0b263a150eb9a9b59f196914629be06a9b (diff)
parent632ed413a9ce62747ded83d7736491b081be4b49 (diff)
downloadzsh-master.tar.gz
zsh-master.tar.bz2
zsh-master.zip
Merge remote-tracking branch 'github/master'HEADmaster
Diffstat (limited to 'plugins/starship/README.md')
-rw-r--r--plugins/starship/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/plugins/starship/README.md b/plugins/starship/README.md
new file mode 100644
index 000000000..0e66c5294
--- /dev/null
+++ b/plugins/starship/README.md
@@ -0,0 +1,21 @@
+# starship plugin
+
+Initializes [starship prompt](https://starship.rs) - a minimal, blazing-fast and infinitely customizable cross-shell prompt.
+
+[Demo](https://user-images.githubusercontent.com/62098008/169764279-50b48262-9506-4651-ba89-f6611a88ebf0.mp4)
+
+[External repository](https://github.com/axieax/zsh-starship) for this zsh plugin.
+
+# Installation
+
+**Note:** you have to [install starship](https://starship.rs/guide/#%F0%9F%9A%80-installation) first.
+
+## [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh)
+
+Add `starship` to the plugins array in your `.zshrc` file:
+
+```zsh
+plugins=(... starship)
+```
+
+## ⚠️ ENABLING THIS PLUGIN WILL UNSET YOUR ZSH_THEME VARIABLE