From ebf8726ab75433db45e76726ab06033e8112ea8c Mon Sep 17 00:00:00 2001 From: xylous Date: Sun, 8 Aug 2021 17:57:38 +0300 Subject: [PATCH] Update README.md --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 37e8904..a9f8751 100644 --- a/README.md +++ b/README.md @@ -20,15 +20,12 @@ Is it useful? For me and probably a handful other people, yes. ### Installation -Run the following command: +Clone this repository locally, on your machine, for example: ``` -git clone https://github.com/Insert-Creative-Name-Here/gitstatus.zsh.git +git clone "https://github.com/xylous/gitstatus.zsh.git" gitstatus ``` -You can move the downloaded repository anywhere you want on your computer -afterwards. - ## Usage Add the following lines to your zshrc: @@ -37,7 +34,7 @@ Add the following lines to your zshrc: function precmd() { local gitstatus="$(path/to/installation/gitstatus.plugin.zsh)" - PS1="%F{blue}%~%F{default} $gitstatus $ " + PS1="%F{blue}%~%F{default} ${gitstatus} $ " } ``` @@ -50,7 +47,8 @@ to the program. ## Roadmap -- [ ] Add screenshots +- [ ] add screenshots +- [ ] cover more `git status` flags ## Contributing