diff --git a/README.md b/README.md index 2d376bc5..f8ecd309 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,46 @@

-
- Starship – Cross-shell prompt -

- Crates.io version - Azure Pipelines Build Status - All Contributors - Chat on Discord -

+
+ Starship – Cross-shell prompt +

+

+ + Crates.io version + + + Azure Pipelines Build Status + + + All Contributors + + + Chat on Discord +

-
- Website · - Installation · - Configuration +
+ Website + · + Installation + · + Configuration

+ Starship is the minimal, blazing fast, and extremely customizable prompt for any shell!
The prompt shows information you need while you're working, while staying sleek and out of the way. @@ -26,15 +50,15 @@ The prompt shows information you need while you're working, while staying sleek ## 🍬 Features -- Prompt character turns red if the last command exits with non-zero code. -- Current username if not the same as the logged-in user. -- Current Node.js version(`⬢`). -- Current Rust version (`🦀`). +- Prompt character turns red if the last command exits with non-zero code +- Current username if not the same as the logged-in user +- Current Node.js version(`⬢`) +- Current Rust version (`🦀`) - Current Ruby version (`💎`). -- Current Python version (`🐍`). -- Current Go version (`🐹`). -- Package version of package in current directory (`📦`). -- Current battery level and status. +- Current Python version (`🐍`) +- Current Go version (`🐹`) +- Package version of package in current directory (`📦`) +- Current battery level and status - Current Git branch and rich repo status: - `=` — conflicting changes - `⇡` — ahead of remote branch @@ -46,8 +70,8 @@ The prompt shows information you need while you're working, while staying sleek - `+` — added files - `»` — renamed files - `✘` — deleted files -- Execution time of the last command if it exceeds the set threshold. -- Indicator for jobs in the background (`✦`). +- Execution time of the last command if it exceeds the set threshold +- Indicator for jobs in the background (`✦`) ## 🚀 Installation @@ -68,32 +92,42 @@ The prompt shows information you need while you're working, while staying sleek ``` #### Rust (v1.33 or higher) - + ```sh $ cargo install starship ``` 1. Add the init script to your shell's config file: - #### Bash / Zsh + #### Bash - Add the following to the end of `~/.bashrc` or `~/.zshrc`: + Add the following to the end of `~/.bashrc`: - ```sh - # ~/.bashrc or ~/.zshrc + ```sh + # ~/.bashrc - eval "$(starship init $0)" - ``` + eval "$(starship init bash)" + ``` - #### Fish + #### Fish - Add the following to the end of `~/.config/fish/config.fish`: + Add the following to the end of `~/.config/fish/config.fish`: - ```sh - # ~/.config/fish/config.fish + ```sh + # ~/.config/fish/config.fish - eval (starship init fish) - ``` + eval (starship init fish) + ``` + + #### Zsh + + Add the following to the end of `~/.zshrc`: + + ```sh + # ~/.zshrc + + eval "$(starship init zsh)" + ``` ## 🔧 Configuration