summaryrefslogtreecommitdiffstats
path: root/docs/README.md
diff options
context:
space:
mode:
authorMatan Kushner <hello@matchai.me>2019-08-18 13:45:36 -0400
committerGitHub <noreply@github.com>2019-08-18 13:45:36 -0400
commitf7a77edb35fba5818504b8cba4be122480b3508a (patch)
tree46bf046ec4facb640ebbb468dd061b4c319d29e6 /docs/README.md
parent5af70b96993d231c02b39a25d523dec2919c8e00 (diff)
docs: Update setup instructions on landing page (#184)
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md52
1 files changed, 36 insertions, 16 deletions
diff --git a/docs/README.md b/docs/README.md
index e47d9684d..73848ff01 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -25,28 +25,48 @@ footer: ISC Licensed | Copyright © 2019-present Starship Contributors
1. Install the **starship** binary:
- ```bash
- cargo install starship
- ```
+ **[Download archives of precompiled binaries](https://github.com/starship/starship/releases)** if you don't use the platforms below.
+
+ #### Homebrew
+
+ ```sh
+ $ brew install starship
+ ```
+
+ #### 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`:
+
+ ```sh
+ # ~/.bashrc
+
+ eval "$(starship init bash)"
+ ```
+
+ #### Fish
+
+ Add the following to the end of `~/.config/fish/config.fish`:
- Add the following to the end of `~/.bashrc` or `~/.zshrc`:
+ ```sh
+ # ~/.config/fish/config.fish
- ```bash
- # ~/.bashrc or ~/.zshrc
-
- eval "$(starship init $0)"
- ```
+ eval (starship init fish)
+ ```
- #### Fish
+ #### Zsh
- Add the following to the end of `~/.config/fish/config.fish`:
+ Add the following to the end of `~/.zshrc`:
- ```sh
- # ~/.config/fish/config.fish
+ ```sh
+ # ~/.zshrc
- eval (starship init fish)
- ```
+ eval "$(starship init zsh)"
+ ```