From 5b440c0bb01b35eff1ebd92af1a2c013668fed04 Mon Sep 17 00:00:00 2001
From: Matan Kushner
Date: Thu, 5 Dec 2019 13:15:21 -0500
Subject: docs: Simplify installation process and docs (#643)
---
README.md | 83 ++++++++++++++++++++++++++-------------------------------------
1 file changed, 34 insertions(+), 49 deletions(-)
(limited to 'README.md')
diff --git a/README.md b/README.md
index 234073c42..44846c525 100644
--- a/README.md
+++ b/README.md
@@ -19,12 +19,12 @@
src="https://repology.org/badge/tiny-repos/starship.svg"
alt="Packaging status"/>
-
-
+
@@ -39,27 +39,27 @@
-
+
-
+
-
+
-
+
-
+
-
+
@@ -82,21 +82,18 @@ 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 Go version (`🐹`)
- Current Java version(`☕`)
- Current Node.js version(`⬢`)
-- Current Rust version (`🦀`)
-- Current Ruby version (`💎`)
-- Current Python version (`🐍`)
- Current PHP version (`🐘`)
-- Current Go version (`🐹`)
-- Nix-shell environment detection
-- Print an environment variable
+- Current Python version (`🐍`)
+- Current Ruby version (`💎`)
+- Current Rust version (`🦀`)
+- Current .NET version (`•NET`)
- Current version of package in current directory (`📦`)
- npm (Node.js)
- cargo (Rust)
- poetry (Python)
-- Current battery level and status
- Current Git branch and rich repo status:
- `=` — conflicting changes
- `⇡` — ahead of remote branch
@@ -108,10 +105,19 @@ 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
+- Current Mercurial branch
+- Current battery level and status
+- `⇡` – charging
+- `⇣` – discharging
+- `•` – fully charged
- Indicator for jobs in the background (`✦`)
- Current Kubernetes Cluster and Namespace (`☸`)
-- Current AWS profile (`☁️`)
+- Current Amazon Web Services (AWS) profile (`☁️`)
+- Execution time of the last command
+- Custom environment variable value
+- Nix-shell environment detection
+- Current username if not the same as the logged-in user
+- Optional current time in 12/24hr format
## 🚀 Installation
@@ -123,48 +129,26 @@ The prompt shows information you need while you're working, while staying sleek
1. Install the **starship** binary:
- **[Download archives of precompiled binaries](https://github.com/starship/starship/releases)** if you don't use the platforms below.
+ #### Install Latest Version
- #### Homebrew
+ ##### With Shell:
```sh
- $ brew install starship
+ curl -fsSL https://starship.rs/install.sh | sh
```
- #### Rust (v1.38 or higher)
+ #### Install via Package Manager
- ```sh
- $ cargo install starship
- ```
-
- #### Arch Linux (AUR)
-
- Starship is available on the AUR under the name `starship`. Install it with `yay` or your favorite AUR helper.
+ ##### With [Homebrew](https://brew.sh/):
```sh
- $ yay -S starship
+ brew install starship
```
- #### Nix (unstable)
+ ##### With [Scoop](https://scoop.sh):
- ```sh
- $ nix-env --install starship
- ```
-
- #### Termux
-
- ```sh
- $ pkg install starship
- ```
-
- #### Other x86-64 Linux Platforms
-
- Download a prebuilt binary and place in /usr/local/bin/
-
- ```sh
- $ wget -q --show-progress https://github.com/starship/starship/releases/latest/download/starship-x86_64-unknown-linux-gnu.tar.gz
- $ tar xvf starship-x86_64-unknown-linux-gnu.tar.gz
- $ sudo mv starship /usr/local/bin/
+ ```powershell
+ scoop install starship
```
1. Add the init script to your shell's config file:
@@ -308,6 +292,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
+
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
--
cgit v1.2.3