summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorromkatv <roman.perepelitsa@gmail.com>2020-05-15 19:06:30 +0300
committerromkatv <roman.perepelitsa@gmail.com>2020-05-15 19:06:30 +0300
commitff18dbaf74beb38f9e0721558f2c66552b5862a4 (patch)
treef0019f4b649eae3e4e4fd75a91e7a84754e085bf /README.md
parent46c76dd7071bedab192aa65756ba09024e29da0c (diff)
Squashed 'gitstatus/' changes from caf5bfd3..4c1b9564
4c1b9564 Merge pull request #128 from carlosedp/arch 1d2816f2 Add support to build on ppc64le and riscv64 archs 5614639c update version in packaging instructions d728a1da add homebrew installation instructions; fixed #118 git-subtree-dir: gitstatus git-subtree-split: 4c1b95643bc78dfe8e4d9566823b72881637c2ef
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 22 insertions, 2 deletions
diff --git a/README.md b/README.md
index aa63eec5..014b4e67 100644
--- a/README.md
+++ b/README.md
@@ -35,6 +35,16 @@ git clone --depth=1 https://github.com/romkatv/gitstatus.git ~/gitstatus
echo 'source ~/gitstatus/gitstatus.prompt.zsh' >>! ~/.zshrc
```
+Alternatively, on macOS you can install with Homebrew:
+
+```zsh
+brew install romkatv/gitstatus/gitstatus
+echo 'source /usr/local/opt/gitstatus/gitstatus.prompt.zsh' >>! ~/.zshrc
+```
+
+(If you choose this option, replace `~/gitstatus` with `/usr/local/opt/gitstatus` in all code
+snippets below.)
+
_Make sure to disable your current theme if you have one._
This will give you a basic yet functional prompt with git status in it. It's
@@ -118,6 +128,16 @@ git clone --depth=1 https://github.com/romkatv/gitstatus.git ~/gitstatus
echo 'source ~/gitstatus/gitstatus.prompt.sh' >> ~/.bashrc
```
+Alternatively, on macOS you can install with Homebrew:
+
+```zsh
+brew install romkatv/gitstatus/gitstatus
+echo 'source /usr/local/opt/gitstatus/gitstatus.prompt.sh' >> ~/.bashrc
+```
+
+(If you choose this option, replace `~/gitstatus` with `/usr/local/opt/gitstatus` in all code
+snippets below.)
+
This will give you a basic yet functional prompt with git status in it. It's
[over 10x faster](#benchmarks) than any alternative that can give you comparable prompt.
@@ -479,7 +499,7 @@ new versions are released.*
```zsh
# Download and extract gitstatus tarball.
-gitstatus_version=1.0.0 # IMPORTANT: CHANGE VERSION TO WHAT YOU WANT
+gitstatus_version=1.1.0 # IMPORTANT: CHANGE VERSION TO WHAT YOU WANT
wget https://github.com/romkatv/gitstatus/archive/v"$gitstatus_version".tar.gz
tar -xzf v"$gitstatus_version".tar.gz
cd gitstatus-"$gitstatus_version"
@@ -508,7 +528,7 @@ libgit2 tarball manually and invoke `./build` without `-w`.
```zsh
# Download and extract gitstatus tarball.
-gitstatus_version=1.0.0 # IMPORTANT: CHANGE VERSION TO WHAT YOU WANT
+gitstatus_version=1.1.0 # IMPORTANT: CHANGE VERSION TO WHAT YOU WANT
wget https://github.com/romkatv/gitstatus/archive/v"$gitstatus_version".tar.gz
tar -xzf v"$gitstatus_version".tar.gz
cd gitstatus-"$gitstatus_version"