summaryrefslogtreecommitdiff
path: root/home/.oh-my-zsh/plugins/starship/README.md
diff options
context:
space:
mode:
authornavewindre <boneyaard@gmail.com>2025-07-13 06:42:05 +0200
committernavewindre <boneyaard@gmail.com>2025-07-13 06:42:05 +0200
commit02f14a9cb152561a5e44062aac79f3b700403b40 (patch)
tree2db8ebda3b7f6f8777783aeb5c60018e6e1359d8 /home/.oh-my-zsh/plugins/starship/README.md
parentcbbdeb2f6b40a102a829f0c47cff052937231f00 (diff)
omz
Diffstat (limited to 'home/.oh-my-zsh/plugins/starship/README.md')
-rw-r--r--home/.oh-my-zsh/plugins/starship/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/home/.oh-my-zsh/plugins/starship/README.md b/home/.oh-my-zsh/plugins/starship/README.md
new file mode 100644
index 0000000..0e66c52
--- /dev/null
+++ b/home/.oh-my-zsh/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