siina/ gitstatus
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
xylous 2021-08-08 17:57:38 +03:00
parent fc9b5ecee6
commit ebf8726ab7
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -20,15 +20,12 @@ Is it useful? For me and probably a handful other people, yes.
### Installation ### 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 ## Usage
Add the following lines to your zshrc: Add the following lines to your zshrc:
@ -37,7 +34,7 @@ Add the following lines to your zshrc:
function precmd() function precmd()
{ {
local gitstatus="$(path/to/installation/gitstatus.plugin.zsh)" 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 ## Roadmap
- [ ] Add screenshots - [ ] add screenshots
- [ ] cover more `git status` flags
## Contributing ## Contributing